Class Organisations

Hierarchy

  • default
    • Organisations

Constructors

constructor

Methods

getOrganisation uploadAsset

Constructors

constructor

  • new Organisations(options): Organisations

  • Parameters

    Returns Organisations

    Example

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

Methods

getOrganisation

  • getOrganisation(): Promise<Organisation>

  • Returns Promise<Organisation>

    Example

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

uploadAsset

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

  • Parameters

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

      The properties of the asset to upload

      • OptionalassetContentType?: string
      • assetData: unknown
      • OptionalassetFileName?: unknown

    Returns 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...

Settings

Member Visibility

On This Page

Constructors
Methods