Skip to main content

Type Alias: PluginConnections

PluginConnections = object

Methods​

create()​

create(input): Promise<PluginMessagingConnection>

Parameters​

input​

PluginConnectionInput

Returns​

Promise<PluginMessagingConnection>

forUser()​

forUser(ownerUserId): Promise<PluginUserConnection[]>

Parameters​

ownerUserId​

string

Returns​

Promise<PluginUserConnection[]>

get()​

get(id): Promise<PluginMessagingConnection | undefined>

Parameters​

id​

string

Returns​

Promise<PluginMessagingConnection | undefined>

inboundPath()​

inboundPath(id): Promise<string>

Parameters​

id​

string

Returns​

Promise<string>

list()​

list(): Promise<PluginMessagingConnection[]>

Returns​

Promise<PluginMessagingConnection[]>

receipts()​

receipts(connectionId, options?): Promise<PluginConnectionReceipts>

Parameters​

connectionId​

string

options?​

PluginConnectionReceiptsOptions

Returns​

Promise<PluginConnectionReceipts>

registerType()​

registerType(definition): () => void

Parameters​

definition​

PluginConnectionTypeDefinition

Returns​

() => void

update()​

update(id, patch): Promise<PluginMessagingConnection>

Parameters​

id​

string

patch​

PluginConnectionPatch

Returns​

Promise<PluginMessagingConnection>

userSecret()​

userSecret(ownerUserId, connectionId, name): Promise<string | undefined>

Parameters​

ownerUserId​

string

connectionId​

string

name​

string

Returns​

Promise<string | undefined>