Type Alias ConnectionProfile

Type declaration

• addNewServiceAccount:function

  • addNewServiceAccount(): Promise<IdObjectSkeletonInterface>

    Create a new service account using auto-generated parameters

    Returns Promise<IdObjectSkeletonInterface>

    A promise resolving to a service account object

• deleteConnectionProfile:function

  • deleteConnectionProfile(host: string): void

    Delete connection profile

    Parameters

    • host: string

      host tenant host url or unique substring

    Returns void

• findConnectionProfiles:function

  • findConnectionProfiles(
        connectionProfiles: ConnectionsFileInterface,
        host: string,
    ): SecureConnectionProfileInterface[]

    Find connection profiles

    Parameters

    • connectionProfiles: ConnectionsFileInterface

      connection profile object
    • host: string

      host url or unique substring

    Returns SecureConnectionProfileInterface[]

    Array of connection profiles

• getConnectionProfile:function

  • getConnectionProfile(): Promise<ConnectionProfileInterface>

    Get connection profile

    Returns Promise<ConnectionProfileInterface>

    connection profile or null

• getConnectionProfileByHost:function

  • getConnectionProfileByHost(host: string): Promise<ConnectionProfileInterface>

    Get connection profile by host

    Parameters

    • host: string

      host tenant host url or unique substring

    Returns Promise<ConnectionProfileInterface>

    connection profile or null

• getConnectionProfilesPath:function

  • getConnectionProfilesPath(): string

    Get connection profiles file name

    Returns string

    connection profiles file name

• initConnectionProfiles:function

  • initConnectionProfiles(): Promise<void>

    Initialize connection profiles

    This method is called from app.ts and runs before any of the message handlers are registered. Therefore none of the Console message functions will produce any output.

    Returns Promise<void>

• loadConnectionProfile:function

  • loadConnectionProfile(): Promise<boolean>

    Load a connection profile into library state

    Returns Promise<boolean>

    A promise resolving to true if successful

• loadConnectionProfileByHost:function

  • loadConnectionProfileByHost(host: string): Promise<boolean>

    Load a connection profile into library state

    Parameters

    • host: string

      AM host URL or unique substring

    Returns Promise<boolean>

    A promise resolving to true if successful

• saveConnectionProfile:function

  • saveConnectionProfile(host: string): Promise<boolean>

    Save connection profile

    Parameters

    • host: string

      host url for new profiles or unique substring for existing profiles

    Returns Promise<boolean>

    true if the operation succeeded, false otherwise