Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DigimeSDK

Hierarchy

  • DigimeSDK

Index

Authorization

exchangeCodeForToken

exchangeCodeForToken: (props: ExchangeCodeForTokenOptions) => Promise<UserAccessToken>

Type declaration

    • This is called when authorization flow successfully completed, and you have been given an authorization code. We can then use this function to exchange for an access token.

      Parameters

      Returns Promise<UserAccessToken>

getAuthorizeUrl

getAuthorizeUrl: (props: GetAuthorizeUrlOptions) => Promise<GetAuthorizeUrlResponse>

Type declaration

    • In order to write or read data from digi.me, we first need to create an access token. Access tokens are linked to a contract, and it is possible to create multiple access tokens that access to the same digi.me libary. This function is called when:

      • Authorize a new user. You have the option to also onboard a service during this process.
      • An existing user authorizing a new contract.
      • Existing user’s refresh token has expired and we need to extend it.
      // run typedoc --help for a list of supported languages
      const instance = new MyClass();
      

      Parameters

      Returns Promise<GetAuthorizeUrlResponse>

getOnboardServiceUrl

getOnboardServiceUrl: (props: GetOnboardServiceUrlOptions) => Promise<GetOnboardServiceUrlResponse>

Type declaration

Delete

deleteUser

deleteUser: (props: DeleteUserOptions) => Promise<DeleteUserResponse>

Type declaration

Read

getAvailableServices

getAvailableServices: (contractId?: string) => Promise<GetAvailableServicesResponse>

Type declaration

readAccounts

readAccounts: (props: ReadAccountsOptions) => Promise<ReadAccountsResponse>

Type declaration

readAllFiles

readAllFiles: (props: ReadAllFilesOptions) => ReadAllFilesResponse

Type declaration

readFile

readFile: (props: ReadFileOptions) => Promise<ReadFileResponse>

Type declaration

readFileList

readFileList: (props: ReadFileListOptions) => Promise<ReadFileListResponse>

Type declaration

readSession

readSession: (props: ReadSessionOptions) => Promise<ReadSessionResponse>

Type declaration

Write

write

write: (props: WriteOptions) => Promise<WriteResponse>

Type declaration

Generated using TypeDoc