Class Bucket

Hierarchy

Bucket

Index

Constructors

Properties

_bucketId _internalClient _providers

Methods

createContext createRawContext createReceiver createSilentContext getId sendMessage sendRawMessage sendSilentMessage createCredentialKey

Constructors

constructor

new Bucket(_bucketId, _internalClient, _providers): Bucket
Parameters
- _bucketId: string
- _internalClient: InternalClient
- _providers: ProviderCredentialsMap
Returns Bucket
- Defined in server/client/bucket.ts:17

Properties

`Private` `Readonly` _bucketId

_bucketId: string

`Private` `Readonly` _internalClient

_internalClient: InternalClient

`Private` `Readonly` _providers

_providers: ProviderCredentialsMap

Methods

createContext

createContext(context): Promise<Context>
Parameters
- context: DataContextMetadata
Returns Promise<Context>
- Defined in server/client/bucket.ts:90

createRawContext

createRawContext(context): Promise<Context>
Parameters
- context: RawContextMetadata
Returns Promise<Context>
- Defined in server/client/bucket.ts:70

createReceiver

createReceiver(subscription): Receiver
All SDK generated subscriptions
Parameters
- subscription: Subscription
  
  SDK Generated Subscription JSON
Returns Receiver
Valid to API receiver format
- Defined in server/client/bucket.ts:34

createSilentContext

createSilentContext(context): Promise<Context>
Parameters
- context: SilentContextMetadata
Returns Promise<Context>
- Defined in server/client/bucket.ts:80

getId

getId(): string
Returns string
- Defined in server/client/bucket.ts:25

sendMessage

sendMessage(receiver, contextMetadata): Promise<MessageResultDto>
Parameters
- receiver: Receiver
- contextMetadata: DataContextMetadata
Returns Promise<MessageResultDto>
- Defined in server/client/bucket.ts:56

sendRawMessage

sendRawMessage(receiver, contextMetadata): Promise<MessageResultDto>
Parameters
- receiver: Receiver
- contextMetadata: RawContextMetadata
Returns Promise<MessageResultDto>
- Defined in server/client/bucket.ts:49

sendSilentMessage

sendSilentMessage(receiver, contextMetadata): Promise<MessageResultDto>
Parameters
- receiver: Receiver
- contextMetadata: SilentContextMetadata
Returns Promise<MessageResultDto>
- Defined in server/client/bucket.ts:63

`Static` createCredentialKey

createCredentialKey(type, ident?): string
Parameters
- type: SubscriptionType
- Optional ident: string
Returns string
- Defined in server/client/bucket.ts:10

Generated using TypeDoc