Interface DefaultChatSocketIOAPIOptions

interface DefaultChatSocketIOAPIOptions {
    authEncSecret: string;
    authSignSecret: string;
    authenticate?: AuthenticationFunction;
    channelPrefix: string;
    cors?: CorsOptions | CorsOptionsDelegate<CorsRequest>;
    namespace: string;
    organizationAPI: Pick<OrganizationDefaultAdapterAPI, "isUserInOrganization">;
}

Hierarchy (view full)

Properties

authEncSecret authSignSecret authenticate? channelPrefix cors? namespace organizationAPI

Properties

authEncSecret

authEncSecret: string

Secret use to encrypt the JWT Token

authSignSecret

authSignSecret: string

Secret use to sign the JWT Token

Optional authenticate

authenticate?: AuthenticationFunction

Function that will be called to authenticate the user via validators. When not provided, this will default to bearer authentication (security.defaultBearerAuth)

Typically you would only provide this if designing your own authentication or using cookie auth via security.defaultCookieAuth.

channelPrefix

channelPrefix: string

Unique prefix for channel names

Optional cors

cors?: CorsOptions | CorsOptionsDelegate<CorsRequest>

Options for cors

namespace

namespace: string

Namespace to use for connection (e.g. /chats, /notifications)

organizationAPI

organizationAPI: Pick<OrganizationDefaultAdapterAPI, "isUserInOrganization">

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc