Interface ChatDefaultAdapterDependencies

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

Properties

bucket db organizationAPI socketAPI? userAPI

Properties

bucket

bucket: Bucket

External bucket for attachments

db

db: Db

Database for loading information

organizationAPI

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

Organization API

Optional socketAPI

socketAPI?: SocketAPI<defaultChat.Message, defaultChat.Subscription>

API for sending messages to a socket (optional)

userAPI

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

User APIs used for the chat service

Type declaration

  • admin: Pick<UserDefaultAdapterAPI, "isAdminUser">

    API used for admin user checks

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

    API used for expanding user info

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc