Interface IAuthentication

Used for header based Authentication.

interface IAuthentication {
    getCometdHandshake(config?: object): object;
    getFetchOptions(options?: IFetchOptions): IFetchOptions;
    logout(): void | Promise<any>;
    updateCredentials(credentials: ICredentials): string;
}

Implemented by

Index

Methods

getCometdHandshake getFetchOptions logout updateCredentials

Methods

getCometdHandshake

getCometdHandshake(config?: object): object
Parameters
- Optionalconfig: object
Returns object
- Defined in packages/client/src/core/IAuthentication.ts:9

getFetchOptions

getFetchOptions(options?: IFetchOptions): IFetchOptions
Parameters
- Optionaloptions: IFetchOptions
Returns IFetchOptions
- Defined in packages/client/src/core/IAuthentication.ts:8

logout

logout(): void | Promise<any>
Returns void | Promise<any>
- Defined in packages/client/src/core/IAuthentication.ts:10

updateCredentials

updateCredentials(credentials: ICredentials): string
Parameters
- credentials: ICredentials
Returns string
- Defined in packages/client/src/core/IAuthentication.ts:7