Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AccountProvider

Represents a provider of accounts for use with the account management service

Hierarchy

  • AccountProvider

Index

Methods

autoOAuthCancelled

  • autoOAuthCancelled(): Thenable<void>
  • Called from the account management service when the user has cancelled an auto OAuth authorization process. Implementations should use this to cancel any polling process and call the end OAuth method.

    Returns Thenable<void>

clear

  • Clears sensitive information for an account. To be called when account is removed

    Parameters

    • accountKey: AccountKey

      Key that uniquely identifies the account to clear

    Returns Thenable<void>

clearTokenCache

  • clearTokenCache(): Thenable<void>
  • Clears token cache

    Returns Thenable<void>

getSecurityToken

  • Generates a security token for the provided account

    deprecated

    use getAccountSecurityToken

    Parameters

    • account: Account

      The account to generate a security token for

    • resource: AzureResource

      The resource to get the token for

    Returns Thenable<{}>

    Promise to return a security token object

initialize

  • Initializes the account provider with the accounts restored from the memento,

    Parameters

    • storedAccounts: Account[]

      Accounts restored from the memento

    Returns Thenable<Account[]>

    Account objects after being rehydrated (if necessary)

prompt

  • Prompts the user to enter account information. Returns an error if the user canceled the operation.

    Returns Thenable<Account | PromptFailedResult>

refresh

  • Refreshes a stale account. Returns an error if the user canceled the operation. Otherwise, returns a new updated account instance.

    Parameters

    Returns Thenable<Account | PromptFailedResult>

Generated using TypeDoc