Frodo Library - v4.0.0-10
    Preparing search index...

    Type Alias ConnectionProfile

    type ConnectionProfile = {
        addNewServiceAccount(): Promise<IdObjectSkeletonInterface>;
        deleteConnectionProfile(host: string): void;
        deleteConnectionProfileAlias(host: string): void;
        findConnectionProfiles(
            connectionProfiles: ConnectionsFileInterface,
            host: string,
        ): SecureConnectionProfileInterface[];
        getConnectionProfile(): Promise<ConnectionProfileInterface>;
        getConnectionProfileByHost(
            host: string,
        ): Promise<ConnectionProfileInterface>;
        getConnectionProfilesPath(): string;
        initConnectionProfiles(): Promise<void>;
        loadConnectionProfile(): Promise<boolean>;
        loadConnectionProfileByHost(host: string): Promise<boolean>;
        saveConnectionProfile(host: string): Promise<boolean>;
        setConnectionProfileAlias(host: string, alias: string): void;
    }
    Index

    Methods

    addNewServiceAccount deleteConnectionProfile deleteConnectionProfileAlias findConnectionProfiles getConnectionProfile getConnectionProfileByHost getConnectionProfilesPath initConnectionProfiles loadConnectionProfile loadConnectionProfileByHost saveConnectionProfile setConnectionProfileAlias

    Methods

    • Delete connection profile

      Parameters

      • host: string

        host tenant, host url, unique substring, or alias

      Returns void

    • Set an alias for an existing connection profile

      Parameters

      • host: string

        host url, unique substring, or alias of existing connection profile

      Returns void

    • Get connection profiles file name

      Returns string

      connection profiles file name

    • 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>

    • Load a connection profile into library state

      Returns Promise<boolean>

      A promise resolving to true if successful

    • Load a connection profile into library state

      Parameters

      • host: string

        AM host URL, unique substring, or alias

      Returns Promise<boolean>

      A promise resolving to true if successful

    • Save connection profile

      Parameters

      • host: string

        host url for new profiles, unique substring or alias for existing profiles

      Returns Promise<boolean>

      true if the operation succeeded, false otherwise

    • Set an alias for an existing connection profile

      Parameters

      • host: string

        host url, unique substring, or alias of existing connection profile

      • alias: string

        alias to be assigned to connection profile

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods