Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Client

Hierarchy

  • Client

Index

Constructors

constructor

Properties

alarm

application

application: ApplicationService

audit

core

deviceRegistration

deviceRegistration: DeviceRegistrationService

deviceRegistrationBulk

deviceRegistrationBulk: DeviceRegistrationBulkService

event

inventory

inventory: InventoryService

measurement

measurement: MeasurementService

operation

operation: OperationService

operationBulk

operationBulk: OperationBulkService

options

options: object

Type declaration

realtime

realtime: Realtime

role

tenant

user

userGroup

userGroup: UserGroupService

userRole

userRole: UserRoleService

Methods

setAuth

  • Parameters

    Returns void

Static authenticate

  • Authenticates the given user.

    example
    
    let client: Client;
    (async () => {
     client = await Client.authenticate({
       user: 'testuser',
       password: 'password1337!',
       tenant: 'yourtenant'
     }, 'https://acme.cumulocity.com');
    
     //you have access to the client api now
     const { data, paging, res }); =  await client.inventory.list({ pageSize: 100 });
    })();
    

    Parameters

    Returns Promise<Client>

Static deviceBootstrap

Generated using TypeDoc