Class DefaultChatSocketIOApi

A simple socket interface for sending messages

Hierarchy (view full)

DefaultSocketIOAPI<defaultChat.Message, defaultChat.Subscription>
- DefaultChatSocketIOApi

Index

Constructors

Methods

close getOrganizationChatChannel getPrivateChatChannel onSubscribe sendMessage startServer

Properties

accessTokenInfo authSecrets io logger opts organizationAPI

Constructors

constructor

new DefaultChatSocketIOApi(opts): DefaultChatSocketIOApi
Parameters
- opts: DefaultChatSocketIOAPIOptions
Returns DefaultChatSocketIOApi
Overrides DefaultSocketIOAPI.constructor
- Defined in src/adapter/default_chat/socket.ts:22

Methods

close

close(): void
Returns void
Inherited from DefaultSocketIOAPI.close
- Defined in src/socket/socket.ts:148

`Protected` getOrganizationChatChannel

getOrganizationChatChannel(params): string
Parameters
- params: {
  organizationId: string;
  }
  - organizationId: string
Returns string
- Defined in src/adapter/default_chat/socket.ts:136

`Protected` getPrivateChatChannel

getPrivateChatChannel(params): string
Parameters
- params: {
  userId: string;
  }
  - userId: string
Returns string
- Defined in src/adapter/default_chat/socket.ts:131

onSubscribe

onSubscribe(userSocket, payload): Promise<null | NBError>
Parameters
- userSocket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>
- payload: unknown
Returns Promise<null | NBError>
Overrides DefaultSocketIOAPI.onSubscribe
- Defined in src/adapter/default_chat/socket.ts:58

sendMessage

sendMessage(options): void
Send a message to a list of recipients Recipients can be arbitrary, but are usually a subscription object on chat service, or a transmission object on notification service
Parameters
- options: {
  message: defaultChat.Message;
  recipients: defaultChat.Subscription[];
  }
  - message: defaultChat.Message
  - recipients: defaultChat.Subscription[]
Returns void
Overrides DefaultSocketIOAPI.sendMessage
- Defined in src/adapter/default_chat/socket.ts:27

startServer

startServer(opts): Promise<void>
Parameters
- opts: {
  env?: "production" | "development";
  server: Server<typeof IncomingMessage, typeof ServerResponse>;
  }
  - Optional env?: "production" | "development"
  - server: Server<typeof IncomingMessage, typeof ServerResponse>
Returns Promise<void>
Inherited from DefaultSocketIOAPI.startServer
- Defined in src/socket/socket.ts:63

Properties

`Protected` accessTokenInfo

accessTokenInfo: Record<string, AccessTokenInfo> = {}

`Protected` authSecrets

authSecrets: AuthSecrets

`Protected` io

io: null | Server<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any> = null

`Protected` logger

logger: null | Logger = null

`Protected` opts

opts: Required<Omit<DefaultSocketIOAPIOptions, "authEncSecret" | "authSignSecret">>

`Protected` organizationAPI

organizationAPI: Pick<OrganizationDefaultAdapterAPI, "isUserInOrganization">

Generated using TypeDoc