Class ConnectionService

Used for setting up connections between Meeco Users to allow the secure sharing of data (see also ShareService)

Hierarchy

Service<ConnectionApi>
- ConnectionService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ConnectionService(environment: Environment, log?: Logger): ConnectionService

Inherited from Service<ConnectionApi>.constructor
- Defined in packages/sdk/src/services/service.ts:48
Parameters
- environment: Environment
- log: Logger = ...
Returns ConnectionService

Properties

Protected environment

environment: Environment

Protected keystoreAPIFactory

keystoreAPIFactory: KeystoreAPIFactory

Protected logger

logger: IFullLogger

Protected vaultAPIFactory

vaultAPIFactory: VaultAPIFactory

Methods

createConnection

createConnection(config: ConnectionCreateData): Promise<{ fromUserConnection: Connection; invitation: Invitation; options: IConnectionMetadata; toUserConnection: Connection }>

- Defined in packages/sdk/src/services/connection-service.ts:38
Note this only works if we have authentication data for both connecting users. For more typical use cases you should manually call InvitationService.create as one user and InvitationService.accept as the other user.

Parameters
- config: ConnectionCreateData
Returns Promise<{ fromUserConnection: Connection; invitation: Invitation; options: IConnectionMetadata; toUserConnection: Connection }>

fetchConnectionWithId

fetchConnectionWithId(credentials: IVaultToken, connectionId: string): Promise<Connection>

- Defined in packages/sdk/src/services/connection-service.ts:130
deprecated

Use get instead.

Parameters
- credentials: IVaultToken
- connectionId: string
Returns Promise<Connection>

findConnectionBetween

findConnectionBetween(fromUser: IVaultToken, toUser: IVaultToken): Promise<{ fromUserConnection: Connection; toUserConnection: Connection }>

- Defined in packages/sdk/src/services/connection-service.ts:155
Helper to find connection between two users (if one exists) Throws an Error if no connection exists.

Parameters
- fromUser: IVaultToken
- toUser: IVaultToken
Returns Promise<{ fromUserConnection: Connection; toUserConnection: Connection }>

get

get(credentials: IVaultToken, connectionId: string): Promise<Connection>

- Defined in packages/sdk/src/services/connection-service.ts:137
Parameters
- credentials: IVaultToken
- connectionId: string
Returns Promise<Connection>

getAPI

getAPI(token: IVaultToken): ConnectionApi

Overrides Service.getAPI
- Defined in packages/sdk/src/services/connection-service.ts:29
Parameters
- token: IVaultToken
Returns ConnectionApi

list

list(credentials: IVaultToken & IDEK, options?: IPageOptions): Promise<IDecryptedConnection[]>

- Defined in packages/sdk/src/services/connection-service.ts:84
Parameters
- credentials: IVaultToken & IDEK
- Optional options: IPageOptions
Returns Promise<IDecryptedConnection[]>

listAll

listAll(credentials: IVaultToken & IDEK): Promise<IDecryptedConnection[]>

- Defined in packages/sdk/src/services/connection-service.ts:104
Parameters
- credentials: IVaultToken & IDEK
Returns Promise<IDecryptedConnection[]>

listConnections

listConnections(credentials: IVaultToken & IDEK): Promise<IDecryptedConnection[]>

- Defined in packages/sdk/src/services/connection-service.ts:80
deprecated

Use list instead.

Parameters
- credentials: IVaultToken & IDEK
Returns Promise<IDecryptedConnection[]>

setLogger

setLogger(logger: Logger): void

Inherited from Service.setLogger
- Defined in packages/sdk/src/services/service.ts:56
Parameters
- logger: Logger
Returns void

Generated using TypeDoc