Class MessagingChatSocketApi<MessageCustomFields>

Type Parameters

MessageCustomFields = unknown

Hierarchy

BaseSocketApi
- MessagingChatSocketApi

Implements

ChatSocketApi<MessageCustomFields>

Constructors

constructor

new MessagingChatSocketApi<MessageCustomFields>(serviceEndpoint, sessionService, options?): MessagingChatSocketApi<MessageCustomFields>
Type Parameters
- MessageCustomFields = unknown
Parameters
- serviceEndpoint: string
- sessionService: SessionService
- Optional options: Partial<ManagerOptions & SocketOptions>
Returns MessagingChatSocketApi<MessageCustomFields>
Overrides BaseSocketApi.constructor
- Defined in src/socket/chatSocket.ts:65

Properties

`Protected` clientSocket

clientSocket: null | Socket<DefaultEventsMap, DefaultEventsMap> = null

serviceEndpoint

serviceEndpoint: string

sessionService

sessionService: SessionService

`Protected` socketIOOptions

socketIOOptions: Partial<ManagerOptions & SocketOptions> = {}

`Protected` subscriptionTimeout

subscriptionTimeout: number = 5000

`Protected` subscriptions

subscriptions: {
    onError: ((error) => void);
    onMessage: ((message) => void);
    organizationId?: string;
    userId?: string;
}[] = []

Type declaration

onError: ((error) => void)
- - (error): void
  - Parameters
    - error: string
    Returns void
onMessage: ((message) => void)
- - (message): void
  - Parameters
    - message: MessageResponse<MessageCustomFields>
    Returns void
Optional organizationId?: string
Optional userId?: string

Methods

connectToSocket

connectToSocket(): Promise<void>
Returns Promise<void>
Inherited from BaseSocketApi.connectToSocket
- Defined in src/socket/base.ts:24

disconnect

disconnect(): Promise<void>
Returns Promise<void>
Inherited from BaseSocketApi.disconnect
- Defined in src/socket/base.ts:100

`Protected` getPaginatedQueryParams

getPaginatedQueryParams(query): string
Parameters
- query: Partial<PaginatedQuery & SearchableQuery & {
  otherParams: Record<string, undefined | string>;
  }>
Returns string
Implementation of ChatSocketApi.getPaginatedQueryParams
Inherited from BaseSocketApi.getPaginatedQueryParams
- Defined in src/api/base.ts:30

`Protected` getPaginatedResponse

getPaginatedResponse<T>(backendResponse): PaginatedResponse<T>
Type Parameters
- T
Parameters
- backendResponse: PaginatedBackendResponse<T>
Returns PaginatedResponse<T>
Implementation of ChatSocketApi.getPaginatedResponse
Inherited from BaseSocketApi.getPaginatedResponse
- Defined in src/api/base.ts:86

getRequiredVersion

getRequiredVersion(): string
On setup, we can call getRequiredVersion and ping() to confirm that the service exists and that it is of a matching version semantically E.g. if required version is ~2.5 and the api returns 2.6.3, then no issue If returns 3.0.1, should log a warning If returns 1.0.2, should throw error saying it isn't new enough

Returns string
Implementation of ChatSocketApi.getRequiredVersion
Overrides BaseSocketApi.getRequiredVersion
- Defined in src/socket/chatSocket.ts:250

`Protected` getServiceUrl

getServiceUrl(path): string
Parameters
- path: string
Returns string
Implementation of ChatSocketApi.getServiceUrl
Inherited from BaseSocketApi.getServiceUrl
- Defined in src/api/base.ts:26

`Protected` getSocketIOOptions

getSocketIOOptions(): Partial<ManagerOptions & SocketOptions>
Returns Partial<ManagerOptions & SocketOptions>
Overrides BaseSocketApi.getSocketIOOptions
- Defined in src/socket/chatSocket.ts:86

`Protected` getSocketNamespace

getSocketNamespace(): string
Returns string
Overrides BaseSocketApi.getSocketNamespace
- Defined in src/socket/chatSocket.ts:82

`Protected` handleDisconnect

handleDisconnect(): Promise<void>
Returns Promise<void>
Overrides BaseSocketApi.handleDisconnect
- Defined in src/socket/chatSocket.ts:122

`Protected` handleError

handleError(error): Promise<void>
Parameters
- error: string
Returns Promise<void>
Overrides BaseSocketApi.handleError
- Defined in src/socket/chatSocket.ts:109

`Protected` handleMessage

handleMessage(message): Promise<void>
Parameters
- message: unknown
Returns Promise<void>
Overrides BaseSocketApi.handleMessage
- Defined in src/socket/chatSocket.ts:90

ping

ping(): Promise<PingResponse>
Ping the backend service to check that it is alive and well

Returns Promise<PingResponse>
Implementation of ChatSocketApi.ping
Inherited from BaseSocketApi.ping
- Defined in src/api/base.ts:17

subscribeToOrganizationId

subscribeToOrganizationId(input): Promise<void>
Register callback for relevant events for the given organizationId This will set up a new socket connection if not currently connected.

If the given org is not currently subscribed, it will send a subscribe event to the backend, otherwise do nothing.

When message events occur, onMessage will be called.
Parameters
- input: {
      onError: ((error) => void);
      onMessage: ((message) => void);
      organizationId: string;
  }
  - onError: ((error) => void)
    - (error): void
      Parameters
      error: string
      Returns void
  - onMessage: ((message) => void)
    - (message): void
      Parameters
      message: MessageResponse<MessageCustomFields>
      Returns void
  - organizationId: string
Returns Promise<void>
Implementation of ChatSocketApi.subscribeToOrganizationId
- Defined in src/socket/chatSocket.ts:126

subscribeToUserId

subscribeToUserId(input): Promise<void>
Register callback for relevant events for the given userId This will set up a new socket connection if not currently connected.

If the given org is not currently subscribed, it will send a subscribe event to the backend, otherwise do nothing.

When message events occur, onMessage will be called.
Parameters
- input: {
      onError: ((error) => void);
      onMessage: ((message) => void);
      userId: string;
  }
  - onError: ((error) => void)
    - (error): void
      Parameters
      error: string
      Returns void
  - onMessage: ((message) => void)
    - (message): void
      Parameters
      message: MessageResponse<MessageCustomFields>
      Returns void
  - userId: string
Returns Promise<void>
Implementation of ChatSocketApi.subscribeToUserId
- Defined in src/socket/chatSocket.ts:170

unsubscribeToOrganizationId

unsubscribeToOrganizationId(input): Promise<void>
Removes subscriptions for the given organizationId.

If all subscriptions are removed, then the socket connection will be closed after a short timeout.
Parameters
- input: {
  organizationId: string;
  }
  - organizationId: string
Returns Promise<void>
Implementation of ChatSocketApi.unsubscribeToOrganizationId
- Defined in src/socket/chatSocket.ts:214

unsubscribeToUserId

unsubscribeToUserId(input): Promise<void>
Removes subscriptions for the given userId.

If all subscriptions are removed, then the socket connection will be closed after a short timeout.
Parameters
- input: {
  userId: string;
  }
  - userId: string
Returns Promise<void>
Implementation of ChatSocketApi.unsubscribeToUserId
- Defined in src/socket/chatSocket.ts:233

Class MessagingChatSocketApi<MessageCustomFields>

Type Parameters

MessageCustomFields = unknown

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

MessageCustomFields = unknown

Parameters

serviceEndpoint: string

sessionService: SessionService

Optional options: Partial<ManagerOptions & SocketOptions>

Returns MessagingChatSocketApi<MessageCustomFields>

Properties

Protected clientSocket

serviceEndpoint

sessionService

Protected socketIOOptions

Protected subscriptionTimeout

Protected subscriptions

Type declaration

onError: ((error) => void)

Parameters

error: string

Returns void

onMessage: ((message) => void)

Parameters

message: MessageResponse<MessageCustomFields>

Returns void

Optional organizationId?: string

Optional userId?: string

Methods

connectToSocket

Returns Promise<void>

disconnect

Returns Promise<void>

Protected getPaginatedQueryParams

Parameters

query: Partial<PaginatedQuery & SearchableQuery & { otherParams: Record<string, undefined | string>; }>

Returns string

Protected getPaginatedResponse

Type Parameters

T

Parameters

backendResponse: PaginatedBackendResponse<T>

Returns PaginatedResponse<T>

getRequiredVersion

Returns string

Protected getServiceUrl

Parameters

path: string

Returns string

Protected getSocketIOOptions

Returns Partial<ManagerOptions & SocketOptions>

Protected getSocketNamespace

Returns string

Protected handleDisconnect

Returns Promise<void>

Protected handleError

Parameters

error: string

Returns Promise<void>

Protected handleMessage

Parameters

message: unknown

Returns Promise<void>

ping

Returns Promise<PingResponse>

subscribeToOrganizationId

Parameters

input: { onError: ((error) => void); onMessage: ((message) => void); organizationId: string; }

onError: ((error) => void)

Parameters

error: string

Returns void

`Optional` options: Partial<ManagerOptions & SocketOptions>

`Protected` clientSocket

`Protected` socketIOOptions

`Protected` subscriptionTimeout

`Protected` subscriptions

`Optional` organizationId?: string

`Optional` userId?: string

`Protected` getPaginatedQueryParams

query: Partial<PaginatedQuery & SearchableQuery & {
otherParams: Record<string, undefined | string>;
}>

`Protected` getPaginatedResponse

`Protected` getServiceUrl

`Protected` getSocketIOOptions

`Protected` getSocketNamespace

`Protected` handleDisconnect

`Protected` handleError

`Protected` handleMessage

input: {
onError: ((error) => void);
onMessage: ((message) => void);
organizationId: string;
}

input: {
onError: ((error) => void);
onMessage: ((message) => void);
userId: string;
}

input: {
organizationId: string;
}

input: {
userId: string;
}