Class default

Implements

InternetOfMeApiType

Index

Constructors

Methods

createInvitationToken getConnections getPairingInformation tryPairing

Constructors

constructor

new default(oneApi: OneApi, models: ModelsHelperType): default
Parameters
- oneApi: OneApi
- models: ModelsHelperType
Returns default
- Defined in api/subApis/InternetOfMeApi.ts:14

Methods

createInvitationToken

createInvitationToken(): Promise<string>
Creates a token from an invitation

Returns Promise<string>
the token
Implementation of InternetOfMeApiType.createInvitationToken
- Defined in api/subApis/InternetOfMeApi.ts:91

getConnections

getConnections(): Promise<ConnectionInfo[]>
Returns Promise<ConnectionInfo[]>
all connections of internet of me instances
Implementation of InternetOfMeApiType.getConnections
- Defined in api/subApis/InternetOfMeApi.ts:100

getPairingInformation

getPairingInformation(invitationLink: string): undefined | Invitation
Parameters
- invitationLink: string
  string format
Returns undefined | Invitation
the invitation information
Implementation of InternetOfMeApiType.getPairingInformation
- Defined in api/subApis/InternetOfMeApi.ts:23

tryPairing

tryPairing(
    invitationToken: string,
    maxTries?: number,
    setError?: (error: Error) => void,
): Promise<() => void>
Tries to pair with the given invitation link.
Parameters
- invitationToken: string
  The token to pair with.
- maxTries: number = 4
  The maximum number of tries to pair with the given invitation link.
- setError: (error: Error) => void = console.error
  The function to set the error.
Returns Promise<() => void>
a function to stop the pairing process IoM listener
Implementation of InternetOfMeApiType.tryPairing
- Defined in api/subApis/InternetOfMeApi.ts:34