Class Organisations

Hierarchy

  • default
    • Organisations

Constructors

constructor

Methods

getOrganisation uploadAsset

Constructors

constructor

  • new Organisations(options): Organisations

  • Example

    const OneBlink = require('@oneblink/sdk')

    const options = {
      accessKey: '123455678901ABCDEFGHIJKL',
      secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
    }
    const organisations = new OneBlink.Organisations(options)

    Parameters

    Returns Organisations

Methods

getOrganisation

  • getOrganisation(): Promise<Organisation>

  • Example

    const organisation = await organisations.getOrganisation()
    // Use organisation here...

    Returns Promise<Organisation>

uploadAsset

  • uploadAsset(asset): Promise<{
        location: string;
    }>

  • Example

    const asset = {
      assetData: 'some kind of data',
      assetFileName: 'myfile.png',
      assetContentType: 'image/png',
    }
    const { location } = await organisations.uploadAsset(asset)
    // Use location here...

    Parameters

    • asset: {
          assetContentType?: string;
          assetData: unknown;
          assetFileName?: unknown;
      }

      The properties of the asset to upload

      • Optional assetContentType?: string
      • assetData: unknown
      • Optional assetFileName?: unknown

    Returns Promise<{
        location: string;
    }>

Settings

Member Visibility

Theme

On This Page