Interface CreateChatDefaultAdapterDependencies

interface CreateChatDefaultAdapterDependencies {
    bucket: string | Bucket;
    db: string | Db;
    organizationAPI: string | Pick<OrganizationDefaultAdapterAPI, "getOrganizationById" | "getOrganizations" | "getUserOrganizations" | "getUserOrganizationRole" | "isUserInOrganization">;
    socketAPI?: SocketAPI<defaultChat.Message, defaultChat.Subscription> | "socketIO";
    userAPI: {
        admin: string | Pick<UserDefaultAdapterAPI, "isAdminUser">;
        expand: string | Pick<UserDefaultAdapterAPI, "getUserById" | "getUsers">;
    };
}

Properties

bucket db organizationAPI socketAPI? userAPI

Properties

bucket

bucket: string | Bucket

External bucket for attachments. If a string is provided, a google bucket client will be created with that bucket name

db

db: string | Db

Mongo db connection, or a connection string for mongodb

organizationAPI

organizationAPI: string | Pick<OrganizationDefaultAdapterAPI, "getOrganizationById" | "getOrganizations" | "getUserOrganizations" | "getUserOrganizationRole" | "isUserInOrganization">

Organization API connector, or a string if using default adapter connection

Optional socketAPI

socketAPI?: SocketAPI<defaultChat.Message, defaultChat.Subscription> | "socketIO"

Socket API connector, or 'socketIO' to create a default socket IO api

userAPI

userAPI: {
    admin: string | Pick<UserDefaultAdapterAPI, "isAdminUser">;
    expand: string | Pick<UserDefaultAdapterAPI, "getUserById" | "getUsers">;
}

User API connector, or a string if using default adapter connection Separate apis can be specified for admin user checks and expand user information

Type declaration

  • admin: string | Pick<UserDefaultAdapterAPI, "isAdminUser">
  • expand: string | Pick<UserDefaultAdapterAPI, "getUserById" | "getUsers">

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc