Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace accounts

Index

Functions

Functions

accountUpdated

  • accountUpdated(updatedAccount: Account): void

  • Notifies the account management service that an account has updated (usually due to the account going stale).

    Parameters

    • updatedAccount: Account

      Account object with updated properties

    Returns void

beginAutoOAuthDeviceCode

  • beginAutoOAuthDeviceCode(providerId: string, title: string, message: string, userCode: string, uri: string): Thenable<void>

  • Launches a flyout dialog that will display the information on how to complete device code OAuth login to the user. Only one flyout can be opened at once and each must be closed by calling endAutoOAuthDeviceCode.

    Parameters

    • providerId: string

      ID of the provider that's requesting the flyout be opened

    • title: string
    • message: string
    • userCode: string
    • uri: string

    Returns Thenable<void>

endAutoOAuthDeviceCode

  • endAutoOAuthDeviceCode(): void

getAccountSecurityToken

  • getAccountSecurityToken(account: Account, tenantId: string, resource: AzureResource): Thenable<{ token: string; tokenType?: string } | undefined>

  • Generates a security token by asking the account's provider

    Parameters

    • account: Account

      The account to retrieve the security token for

    • tenantId: string

      The ID of the tenant associated with this account

    • resource: AzureResource

      Type of resource to get the security token for (defaults to AzureResource.ResourceManagement if not given)

    Returns Thenable<{ token: string; tokenType?: string } | undefined>

getAllAccounts

  • getAllAccounts(): Thenable<Account[]>

  • Gets all added accounts.

    Returns Thenable<Account[]>

    Promise to return the accounts

getSecurityToken

  • Generates a security token by asking the account's provider

    deprecated

    use getAccountSecurityToken

    Parameters

    • account: Account

      Account to generate security token for

    • Optional resource: AzureResource

      Type of resource to get the security token for (defaults to AzureResource.ResourceManagement if not given)

    Returns Thenable<{}>

    Promise to return the security token

Const onDidChangeAccounts

  • onDidChangeAccounts(listener: (e: DidChangeAccountsParams) => any, thisArgs?: any, disposables?: Disposable[]): Disposable

registerAccountProvider

Generated using TypeDoc