Class Ctx

Hierarchy

Implements

ICtx

Constructors

constructor

new Ctx(options): Ctx
Parameters
- options: ICtxOptions
Returns Ctx
- Defined in src/Classes/Ctx.ts:19

Properties

_args

_args: string[]

_client

_client: {
    addChatLabel: ((jid, labelId) => Promise<void>);
    addLabel: ((jid, labels) => Promise<void>);
    addMessageLabel: ((jid, messageId, labelId) => Promise<void>);
    appPatch: ((patchCreate) => Promise<void>);
    assertSessions: ((jids, force) => Promise<boolean>);
    authState: {
        creds: AuthenticationCreds;
        keys: SignalKeyStoreWithTransaction;
    };
    chatModify: ((mod, jid) => Promise<void>);
    cleanDirtyBits: ((type, fromTimestamp?) => Promise<void>);
    createParticipantNodes: ((jids, message, extraAttrs?) => Promise<{
        nodes: BinaryNode[];
        shouldIncludeDeviceIdentity: boolean;
    }>);
    end: ((error) => void);
    ev: BaileysEventEmitter & {
        buffer() => void;
        createBufferedFunction<A, T_1>(work) => ((...args) => Promise<T_1>);
        flush(force?) => boolean;
        isBuffering() => boolean;
        process(handler) => (() => void);
    };
    executeUSyncQuery: ((usyncQuery) => Promise<undefined | USyncQueryResult>);
    fetchBlocklist: (() => Promise<string[]>);
    fetchDisappearingDuration: ((...jids) => Promise<undefined | USyncQueryResultList[]>);
    fetchMessageHistory: ((count, oldestMsgKey, oldestMsgTimestamp) => Promise<string>);
    fetchPrivacySettings: ((force?) => Promise<{
        [_: string]: string;
    }>);
    fetchStatus: ((...jids) => Promise<undefined | USyncQueryResultList[]>);
    generateMessageTag: (() => string);
    getBusinessProfile: ((jid) => Promise<void | WABusinessProfile>);
    getCatalog: ((__namedParameters) => Promise<{
        nextPageCursor: undefined | string;
        products: Product[];
    }>);
    getCollections: ((jid?, limit?) => Promise<{
        collections: CatalogCollection[];
    }>);
    getOrderDetails: ((orderId, tokenBase64) => Promise<OrderDetails>);
    getPrivacyTokens: ((jids) => Promise<BinaryNode>);
    getUSyncDevices: ((jids, useCache, ignoreZeroDevices) => Promise<JidWithDevice[]>);
    groupAcceptInvite: ((code) => Promise<undefined | string>);
    groupAcceptInviteV4: ((key, inviteMessage) => Promise<string>);
    groupCreate: ((subject, participants) => Promise<GroupMetadata>);
    groupFetchAllParticipating: (() => Promise<{
        [_: string]: GroupMetadata;
    }>);
    groupGetInviteInfo: ((code) => Promise<GroupMetadata>);
    groupInviteCode: ((jid) => Promise<undefined | string>);
    groupJoinApprovalMode: ((jid, mode) => Promise<void>);
    groupLeave: ((id) => Promise<void>);
    groupMemberAddMode: ((jid, mode) => Promise<void>);
    groupMetadata: ((jid) => Promise<GroupMetadata>);
    groupParticipantsUpdate: ((jid, participants, action) => Promise<{
        content: BinaryNode;
        jid: string;
        status: string;
    }[]>);
    groupRequestParticipantsList: ((jid) => Promise<{
        [key: string]: string;
    }[]>);
    groupRequestParticipantsUpdate: ((jid, participants, action) => Promise<{
        jid: string;
        status: string;
    }[]>);
    groupRevokeInvite: ((jid) => Promise<undefined | string>);
    groupRevokeInviteV4: ((groupJid, invitedJid) => Promise<boolean>);
    groupSettingUpdate: ((jid, setting) => Promise<void>);
    groupToggleEphemeral: ((jid, ephemeralExpiration) => Promise<void>);
    groupUpdateDescription: ((jid, description?) => Promise<void>);
    groupUpdateSubject: ((jid, subject) => Promise<void>);
    logger: ILogger;
    logout: ((msg?) => Promise<void>);
    onUnexpectedError: ((err, msg) => void);
    onWhatsApp: ((...jids) => Promise<undefined | {
        exists: unknown;
        jid: string;
    }[]>);
    presenceSubscribe: ((toJid, tcToken?) => Promise<void>);
    processingMutex: {
        mutex<T>(code) => Promise<T>;
    };
    productCreate: ((create) => Promise<Product>);
    productDelete: ((productIds) => Promise<{
        deleted: number;
    }>);
    productUpdate: ((productId, update) => Promise<Product>);
    profilePictureUrl: ((jid, type?, timeoutMs?) => Promise<undefined | string>);
    query: ((node, timeoutMs?) => Promise<BinaryNode>);
    readMessages: ((keys) => Promise<void>);
    refreshMediaConn: ((forceGet?) => Promise<MediaConnInfo>);
    rejectCall: ((callId, callFrom) => Promise<void>);
    relayMessage: ((jid, message, __namedParameters) => Promise<string>);
    removeChatLabel: ((jid, labelId) => Promise<void>);
    removeMessageLabel: ((jid, messageId, labelId) => Promise<void>);
    removeProfilePicture: ((jid) => Promise<void>);
    requestPairingCode: ((phoneNumber) => Promise<string>);
    requestPlaceholderResend: ((messageKey) => Promise<undefined | string>);
    resyncAppState: ((collections, isInitialSync) => Promise<void>);
    sendMessage: ((jid, content, options?) => Promise<undefined | WebMessageInfo>);
    sendMessageAck: ((__namedParameters, errorCode?) => Promise<void>);
    sendNode: ((frame) => Promise<void>);
    sendPeerDataOperationMessage: ((pdoMessage) => Promise<string>);
    sendPresenceUpdate: ((type, toJid?) => Promise<void>);
    sendRawMessage: ((data) => Promise<void>);
    sendReceipt: ((jid, participant, messageIds, type) => Promise<void>);
    sendReceipts: ((keys, type) => Promise<void>);
    sendRetryRequest: ((node, forceIncludeKeys?) => Promise<void>);
    sendWAMBuffer: ((wamBuffer) => Promise<BinaryNode>);
    signalRepository: SignalRepository;
    star: ((jid, messages, star) => Promise<void>);
    type: "md";
    updateBlockStatus: ((jid, action) => Promise<void>);
    updateCallPrivacy: ((value) => Promise<void>);
    updateDefaultDisappearingMode: ((duration) => Promise<void>);
    updateGroupsAddPrivacy: ((value) => Promise<void>);
    updateLastSeenPrivacy: ((value) => Promise<void>);
    updateMediaMessage: ((message) => Promise<IWebMessageInfo>);
    updateMessagesPrivacy: ((value) => Promise<void>);
    updateOnlinePrivacy: ((value) => Promise<void>);
    updateProfileName: ((name) => Promise<void>);
    updateProfilePicture: ((jid, content) => Promise<void>);
    updateProfilePicturePrivacy: ((value) => Promise<void>);
    updateProfileStatus: ((status) => Promise<void>);
    updateReadReceiptsPrivacy: ((value) => Promise<void>);
    updateStatusPrivacy: ((value) => Promise<void>);
    uploadPreKeys: ((count?) => Promise<void>);
    uploadPreKeysToServerIfRequired: (() => Promise<void>);
    upsertMessage: ((msg, type) => Promise<void>);
    user: undefined | Contact;
    waUploadToServer: WAMediaUploadFunction;
    waitForConnectionUpdate: ((check, timeoutMs?) => Promise<void>);
    waitForMessage: (<T_2>(msgId, timeoutMs?) => Promise<T_2>);
    waitForSocketOpen: (() => Promise<void>);
    ws: WebSocketClient;
}

Type declaration

addChatLabel: ((jid, labelId) => Promise<void>)
- - (jid, labelId): Promise<void>
  - Parameters
    - jid: string
    - labelId: string
    Returns Promise<void>
addLabel: ((jid, labels) => Promise<void>)
- - (jid, labels): Promise<void>
  - Parameters
    - jid: string
    - labels: LabelActionBody
    Returns Promise<void>
addMessageLabel: ((jid, messageId, labelId) => Promise<void>)
- - (jid, messageId, labelId): Promise<void>
  - Parameters
    - jid: string
    - messageId: string
    - labelId: string
    Returns Promise<void>
appPatch: ((patchCreate) => Promise<void>)
- - (patchCreate): Promise<void>
  - Parameters
    - patchCreate: WAPatchCreate
    Returns Promise<void>
assertSessions: ((jids, force) => Promise<boolean>)
- - (jids, force): Promise<boolean>
  - Parameters
    - jids: string[]
    - force: boolean
    Returns Promise<boolean>
authState: {
creds: AuthenticationCreds;
keys: SignalKeyStoreWithTransaction;
}
- creds: AuthenticationCreds
- keys: SignalKeyStoreWithTransaction
chatModify: ((mod, jid) => Promise<void>)
- - (mod, jid): Promise<void>
  - Parameters
    - mod: ChatModification
    - jid: string
    Returns Promise<void>
cleanDirtyBits: ((type, fromTimestamp?) => Promise<void>)
- - (type, fromTimestamp?): Promise<void>
  - Parameters
    - type: "account_sync" | "groups"
    - Optional fromTimestamp: string | number
    Returns Promise<void>
createParticipantNodes: ((jids, message, extraAttrs?) => Promise<{
nodes: BinaryNode[];
shouldIncludeDeviceIdentity: boolean;
}>)
- - (jids, message, extraAttrs?): Promise<{
    nodes: BinaryNode[];
    shouldIncludeDeviceIdentity: boolean;
    }>
  - Parameters
    - jids: string[]
    - message: IMessage
    - Optional extraAttrs: {
      [key: string]: string;
      }
      
      [key: string]: string
    Returns Promise<{
    nodes: BinaryNode[];
    shouldIncludeDeviceIdentity: boolean;
    }>
end: ((error) => void)
- - (error): void
  - Parameters
    - error: undefined | Error
    Returns void
ev: BaileysEventEmitter & {
    buffer() => void;
    createBufferedFunction<A, T_1>(work) => ((...args) => Promise<T_1>);
    flush(force?) => boolean;
    isBuffering() => boolean;
    process(handler) => (() => void);
}
executeUSyncQuery: ((usyncQuery) => Promise<undefined | USyncQueryResult>)
- - (usyncQuery): Promise<undefined | USyncQueryResult>
  - Parameters
    - usyncQuery: USyncQuery
    Returns Promise<undefined | USyncQueryResult>
fetchBlocklist: (() => Promise<string[]>)
- - (): Promise<string[]>
  - Returns Promise<string[]>
fetchDisappearingDuration: ((...jids) => Promise<undefined | USyncQueryResultList[]>)
- - (...jids): Promise<undefined | USyncQueryResultList[]>
  - Parameters
    - Rest ...jids: string[]
    Returns Promise<undefined | USyncQueryResultList[]>
fetchMessageHistory: ((count, oldestMsgKey, oldestMsgTimestamp) => Promise<string>)
- - (count, oldestMsgKey, oldestMsgTimestamp): Promise<string>
  - Parameters
    - count: number
    - oldestMsgKey: IMessageKey
    - oldestMsgTimestamp: any
    Returns Promise<string>
fetchPrivacySettings: ((force?) => Promise<{
[_: string]: string;
}>)
- - (force?): Promise<{
    [_: string]: string;
    }>
  - Parameters
    - Optional force: boolean
    Returns Promise<{
    [_: string]: string;
    }>
fetchStatus: ((...jids) => Promise<undefined | USyncQueryResultList[]>)
- - (...jids): Promise<undefined | USyncQueryResultList[]>
  - Parameters
    - Rest ...jids: string[]
    Returns Promise<undefined | USyncQueryResultList[]>
generateMessageTag: (() => string)
- - (): string
  - Returns string
getBusinessProfile: ((jid) => Promise<void | WABusinessProfile>)
- - (jid): Promise<void | WABusinessProfile>
  - Parameters
    - jid: string
    Returns Promise<void | WABusinessProfile>
getCatalog: ((__namedParameters) => Promise<{
nextPageCursor: undefined | string;
products: Product[];
}>)
- - (__namedParameters): Promise<{
    nextPageCursor: undefined | string;
    products: Product[];
    }>
  - Parameters
    - __namedParameters: GetCatalogOptions
    Returns Promise<{
    nextPageCursor: undefined | string;
    products: Product[];
    }>
getCollections: ((jid?, limit?) => Promise<{
collections: CatalogCollection[];
}>)
- - (jid?, limit?): Promise<{
    collections: CatalogCollection[];
    }>
  - Parameters
    - Optional jid: string
    - Optional limit: number
    Returns Promise<{
    collections: CatalogCollection[];
    }>
getOrderDetails: ((orderId, tokenBase64) => Promise<OrderDetails>)
- - (orderId, tokenBase64): Promise<OrderDetails>
  - Parameters
    - orderId: string
    - tokenBase64: string
    Returns Promise<OrderDetails>
getPrivacyTokens: ((jids) => Promise<BinaryNode>)
- - (jids): Promise<BinaryNode>
  - Parameters
    - jids: string[]
    Returns Promise<BinaryNode>
getUSyncDevices: ((jids, useCache, ignoreZeroDevices) => Promise<JidWithDevice[]>)
- - (jids, useCache, ignoreZeroDevices): Promise<JidWithDevice[]>
  - Parameters
    - jids: string[]
    - useCache: boolean
    - ignoreZeroDevices: boolean
    Returns Promise<JidWithDevice[]>
groupAcceptInvite: ((code) => Promise<undefined | string>)
- - (code): Promise<undefined | string>
  - Parameters
    - code: string
    Returns Promise<undefined | string>
groupAcceptInviteV4: ((key, inviteMessage) => Promise<string>)
- - (key, inviteMessage): Promise<string>
  - Parameters
    - key: string | IMessageKey
    - inviteMessage: IGroupInviteMessage
    Returns Promise<string>
groupCreate: ((subject, participants) => Promise<GroupMetadata>)
- - (subject, participants): Promise<GroupMetadata>
  - Parameters
    - subject: string
    - participants: string[]
    Returns Promise<GroupMetadata>
groupFetchAllParticipating: (() => Promise<{
[_: string]: GroupMetadata;
}>)
- - (): Promise<{
    [_: string]: GroupMetadata;
    }>
  - Returns Promise<{
    [_: string]: GroupMetadata;
    }>
groupGetInviteInfo: ((code) => Promise<GroupMetadata>)
- - (code): Promise<GroupMetadata>
  - Parameters
    - code: string
    Returns Promise<GroupMetadata>
groupInviteCode: ((jid) => Promise<undefined | string>)
- - (jid): Promise<undefined | string>
  - Parameters
    - jid: string
    Returns Promise<undefined | string>
groupJoinApprovalMode: ((jid, mode) => Promise<void>)
- - (jid, mode): Promise<void>
  - Parameters
    - jid: string
    - mode: "on" | "off"
    Returns Promise<void>
groupLeave: ((id) => Promise<void>)
- - (id): Promise<void>
  - Parameters
    - id: string
    Returns Promise<void>
groupMemberAddMode: ((jid, mode) => Promise<void>)
- - (jid, mode): Promise<void>
  - Parameters
    - jid: string
    - mode: "all_member_add" | "admin_add"
    Returns Promise<void>
groupMetadata: ((jid) => Promise<GroupMetadata>)
- - (jid): Promise<GroupMetadata>
  - Parameters
    - jid: string
    Returns Promise<GroupMetadata>
groupParticipantsUpdate: ((jid, participants, action) => Promise<{
    content: BinaryNode;
    jid: string;
    status: string;
}[]>)
- - (jid, participants, action): Promise<{
        content: BinaryNode;
        jid: string;
        status: string;
    }[]>
  - Parameters
    - jid: string
    - participants: string[]
    - action: ParticipantAction
    Returns Promise<{
        content: BinaryNode;
        jid: string;
        status: string;
    }[]>
groupRequestParticipantsList: ((jid) => Promise<{
[key: string]: string;
}[]>)
- - (jid): Promise<{
    [key: string]: string;
    }[]>
  - Parameters
    - jid: string
    Returns Promise<{
    [key: string]: string;
    }[]>
groupRequestParticipantsUpdate: ((jid, participants, action) => Promise<{
jid: string;
status: string;
}[]>)
- - (jid, participants, action): Promise<{
    jid: string;
    status: string;
    }[]>
  - Parameters
    - jid: string
    - participants: string[]
    - action: "reject" | "approve"
    Returns Promise<{
    jid: string;
    status: string;
    }[]>
groupRevokeInvite: ((jid) => Promise<undefined | string>)
- - (jid): Promise<undefined | string>
  - Parameters
    - jid: string
    Returns Promise<undefined | string>
groupRevokeInviteV4: ((groupJid, invitedJid) => Promise<boolean>)
- - (groupJid, invitedJid): Promise<boolean>
  - Parameters
    - groupJid: string
    - invitedJid: string
    Returns Promise<boolean>
groupSettingUpdate: ((jid, setting) => Promise<void>)
- - (jid, setting): Promise<void>
  - Parameters
    - jid: string
    - setting: "announcement" | "not_announcement" | "locked" | "unlocked"
    Returns Promise<void>
groupToggleEphemeral: ((jid, ephemeralExpiration) => Promise<void>)
- - (jid, ephemeralExpiration): Promise<void>
  - Parameters
    - jid: string
    - ephemeralExpiration: number
    Returns Promise<void>
groupUpdateDescription: ((jid, description?) => Promise<void>)
- - (jid, description?): Promise<void>
  - Parameters
    - jid: string
    - Optional description: string
    Returns Promise<void>
groupUpdateSubject: ((jid, subject) => Promise<void>)
- - (jid, subject): Promise<void>
  - Parameters
    - jid: string
    - subject: string
    Returns Promise<void>
logger: ILogger
logout: ((msg?) => Promise<void>)
- - (msg?): Promise<void>
  - Parameters
    - Optional msg: string
    Returns Promise<void>
onUnexpectedError: ((err, msg) => void)
- - (err, msg): void
  - Parameters
    - err: Error | Boom<any>
    - msg: string
    Returns void
onWhatsApp: ((...jids) => Promise<undefined | {
exists: unknown;
jid: string;
}[]>)
- - (...jids): Promise<undefined | {
    exists: unknown;
    jid: string;
    }[]>
  - Parameters
    - Rest ...jids: string[]
    Returns Promise<undefined | {
    exists: unknown;
    jid: string;
    }[]>
presenceSubscribe: ((toJid, tcToken?) => Promise<void>)
- - (toJid, tcToken?): Promise<void>
  - Parameters
    - toJid: string
    - Optional tcToken: Buffer
    Returns Promise<void>
processingMutex: {
mutex<T>(code) => Promise<T>;
}
- mutex:function
  - mutex<T>(code): Promise<T>
  - Type Parameters
    - T
    Parameters
    - code: (() => T | Promise<T>)
      
      (): T | Promise<T>
      
      Returns T | Promise<T>
    Returns Promise<T>
    - Defined in node_modules/.pnpm/@whiskeysockets+baileys@6.7_f966cb5c9a5266cd5f6d91ebdf31ebe4/node_modules/@whiskeysockets/baileys/lib/Socket/index.d.ts:77
productCreate: ((create) => Promise<Product>)
- - (create): Promise<Product>
  - Parameters
    - create: ProductCreate
    Returns Promise<Product>
productDelete: ((productIds) => Promise<{
deleted: number;
}>)
- - (productIds): Promise<{
    deleted: number;
    }>
  - Parameters
    - productIds: string[]
    Returns Promise<{
    deleted: number;
    }>
productUpdate: ((productId, update) => Promise<Product>)
- - (productId, update): Promise<Product>
  - Parameters
    - productId: string
    - update: ProductUpdate
    Returns Promise<Product>
profilePictureUrl: ((jid, type?, timeoutMs?) => Promise<undefined | string>)
- - (jid, type?, timeoutMs?): Promise<undefined | string>
  - Parameters
    - jid: string
    - Optional type: "image" | "preview"
    - Optional timeoutMs: number
    Returns Promise<undefined | string>
query: ((node, timeoutMs?) => Promise<BinaryNode>)
- - (node, timeoutMs?): Promise<BinaryNode>
  - Parameters
    - node: BinaryNode
    - Optional timeoutMs: number
    Returns Promise<BinaryNode>
readMessages: ((keys) => Promise<void>)
- - (keys): Promise<void>
  - Parameters
    - keys: IMessageKey[]
    Returns Promise<void>
refreshMediaConn: ((forceGet?) => Promise<MediaConnInfo>)
- - (forceGet?): Promise<MediaConnInfo>
  - Parameters
    - Optional forceGet: boolean
    Returns Promise<MediaConnInfo>
rejectCall: ((callId, callFrom) => Promise<void>)
- - (callId, callFrom): Promise<void>
  - Parameters
    - callId: string
    - callFrom: string
    Returns Promise<void>
relayMessage: ((jid, message, __namedParameters) => Promise<string>)
- - (jid, message, __namedParameters): Promise<string>
  - Parameters
    - jid: string
    - message: IMessage
    - __namedParameters: MessageRelayOptions
    Returns Promise<string>
removeChatLabel: ((jid, labelId) => Promise<void>)
- - (jid, labelId): Promise<void>
  - Parameters
    - jid: string
    - labelId: string
    Returns Promise<void>
removeMessageLabel: ((jid, messageId, labelId) => Promise<void>)
- - (jid, messageId, labelId): Promise<void>
  - Parameters
    - jid: string
    - messageId: string
    - labelId: string
    Returns Promise<void>
removeProfilePicture: ((jid) => Promise<void>)
- - (jid): Promise<void>
  - Parameters
    - jid: string
    Returns Promise<void>
requestPairingCode: ((phoneNumber) => Promise<string>)
- - (phoneNumber): Promise<string>
  - Parameters
    - phoneNumber: string
    Returns Promise<string>
requestPlaceholderResend: ((messageKey) => Promise<undefined | string>)
- - (messageKey): Promise<undefined | string>
  - Parameters
    - messageKey: IMessageKey
    Returns Promise<undefined | string>
resyncAppState: ((collections, isInitialSync) => Promise<void>)
- - (collections, isInitialSync): Promise<void>
  - Parameters
    - collections: readonly ("critical_block" | "critical_unblock_low" | "regular_high" | "regular_low" | "regular")[]
    - isInitialSync: boolean
    Returns Promise<void>
sendMessage: ((jid, content, options?) => Promise<undefined | WebMessageInfo>)
- - (jid, content, options?): Promise<undefined | WebMessageInfo>
  - Parameters
    - jid: string
    - content: AnyMessageContent
    - Optional options: MiscMessageGenerationOptions
    Returns Promise<undefined | WebMessageInfo>
sendMessageAck: ((__namedParameters, errorCode?) => Promise<void>)
- - (__namedParameters, errorCode?): Promise<void>
  - Parameters
    - __namedParameters: BinaryNode
    - Optional errorCode: number
    Returns Promise<void>
sendNode: ((frame) => Promise<void>)
- - (frame): Promise<void>
  - Parameters
    - frame: BinaryNode
    Returns Promise<void>
sendPeerDataOperationMessage: ((pdoMessage) => Promise<string>)
- - (pdoMessage): Promise<string>
  - Parameters
    - pdoMessage: IPeerDataOperationRequestMessage
    Returns Promise<string>
sendPresenceUpdate: ((type, toJid?) => Promise<void>)
- - (type, toJid?): Promise<void>
  - Parameters
    - type: WAPresence
    - Optional toJid: string
    Returns Promise<void>
sendRawMessage: ((data) => Promise<void>)
- - (data): Promise<void>
  - Parameters
    - data: Buffer | Uint8Array
    Returns Promise<void>
sendReceipt: ((jid, participant, messageIds, type) => Promise<void>)
- - (jid, participant, messageIds, type): Promise<void>
  - Parameters
    - jid: string
    - participant: undefined | string
    - messageIds: string[]
    - type: MessageReceiptType
    Returns Promise<void>
sendReceipts: ((keys, type) => Promise<void>)
- - (keys, type): Promise<void>
  - Parameters
    - keys: IMessageKey[]
    - type: MessageReceiptType
    Returns Promise<void>
sendRetryRequest: ((node, forceIncludeKeys?) => Promise<void>)
- - (node, forceIncludeKeys?): Promise<void>
  - Parameters
    - node: BinaryNode
    - Optional forceIncludeKeys: boolean
    Returns Promise<void>
sendWAMBuffer: ((wamBuffer) => Promise<BinaryNode>)
- - (wamBuffer): Promise<BinaryNode>
  - Parameters
    - wamBuffer: Buffer
    Returns Promise<BinaryNode>
signalRepository: SignalRepository
star: ((jid, messages, star) => Promise<void>)
- - (jid, messages, star): Promise<void>
  - Parameters
    - jid: string
    - messages: {
      fromMe?: boolean;
      id: string;
      }[]
    - star: boolean
    Returns Promise<void>
type: "md"
updateBlockStatus: ((jid, action) => Promise<void>)
- - (jid, action): Promise<void>
  - Parameters
    - jid: string
    - action: "block" | "unblock"
    Returns Promise<void>
updateCallPrivacy: ((value) => Promise<void>)
- - (value): Promise<void>
  - Parameters
    - value: WAPrivacyCallValue
    Returns Promise<void>
updateDefaultDisappearingMode: ((duration) => Promise<void>)
- - (duration): Promise<void>
  - Parameters
    - duration: number
    Returns Promise<void>
updateGroupsAddPrivacy: ((value) => Promise<void>)
- - (value): Promise<void>
  - Parameters
    - value: WAPrivacyGroupAddValue
    Returns Promise<void>
updateLastSeenPrivacy: ((value) => Promise<void>)
- - (value): Promise<void>
  - Parameters
    - value: WAPrivacyValue
    Returns Promise<void>
updateMediaMessage: ((message) => Promise<IWebMessageInfo>)
- - (message): Promise<IWebMessageInfo>
  - Parameters
    - message: IWebMessageInfo
    Returns Promise<IWebMessageInfo>
updateMessagesPrivacy: ((value) => Promise<void>)
- - (value): Promise<void>
  - Parameters
    - value: WAPrivacyMessagesValue
    Returns Promise<void>
updateOnlinePrivacy: ((value) => Promise<void>)
- - (value): Promise<void>
  - Parameters
    - value: WAPrivacyOnlineValue
    Returns Promise<void>
updateProfileName: ((name) => Promise<void>)
- - (name): Promise<void>
  - Parameters
    - name: string
    Returns Promise<void>
updateProfilePicture: ((jid, content) => Promise<void>)
- - (jid, content): Promise<void>
  - Parameters
    - jid: string
    - content: WAMediaUpload
    Returns Promise<void>
updateProfilePicturePrivacy: ((value) => Promise<void>)
- - (value): Promise<void>
  - Parameters
    - value: WAPrivacyValue
    Returns Promise<void>
updateProfileStatus: ((status) => Promise<void>)
- - (status): Promise<void>
  - Parameters
    - status: string
    Returns Promise<void>
updateReadReceiptsPrivacy: ((value) => Promise<void>)
- - (value): Promise<void>
  - Parameters
    - value: WAReadReceiptsValue
    Returns Promise<void>
updateStatusPrivacy: ((value) => Promise<void>)
- - (value): Promise<void>
  - Parameters
    - value: WAPrivacyValue
    Returns Promise<void>
uploadPreKeys: ((count?) => Promise<void>)
- - (count?): Promise<void>
  - Parameters
    - Optional count: number
    Returns Promise<void>
uploadPreKeysToServerIfRequired: (() => Promise<void>)
- - (): Promise<void>
  - Returns Promise<void>
upsertMessage: ((msg, type) => Promise<void>)
- - (msg, type): Promise<void>
  - Parameters
    - msg: IWebMessageInfo
    - type: MessageUpsertType
    Returns Promise<void>
user: undefined | Contact
waUploadToServer: WAMediaUploadFunction
waitForConnectionUpdate: ((check, timeoutMs?) => Promise<void>)
- - (check, timeoutMs?): Promise<void>
  - Parameters
    - check: ((u) => Promise<undefined | boolean>)
      
      (u): Promise<undefined | boolean>
      
      Parameters
      
      u: Partial<ConnectionState>
      
      Returns Promise<undefined | boolean>
    - Optional timeoutMs: number
    Returns Promise<void>
waitForMessage: (<T_2>(msgId, timeoutMs?) => Promise<T_2>)
- - <T_2>(msgId, timeoutMs?): Promise<T_2>
  - Type Parameters
    - T_2
    Parameters
    - msgId: string
    - Optional timeoutMs: number
    Returns Promise<T_2>
waitForSocketOpen: (() => Promise<void>)
- - (): Promise<void>
  - Returns Promise<void>
ws: WebSocketClient

_config

_config: {
cmd: undefined | Collection<number | ICommandOptions, any>;
prefix: string | RegExp | string[];
}

Type declaration

cmd: undefined | Collection<number | ICommandOptions, any>
prefix: string | RegExp | string[]

_msg

_msg: IMessageInfo

_self

_self: ICtxSelf

_sender

_sender: {
    decodedJid: undefined | null | string;
    jid: undefined | null | string;
    pushName: undefined | null | string;
}

Type declaration

decodedJid: undefined | null | string
jid: undefined | null | string
pushName: undefined | null | string

_used

_used: {
    command?: string;
    hears?: any;
    poll?: any;
    pollVote?: any;
    prefix?: string | string[];
    reactions?: any;
    upsert?: any;
}

Type declaration

Optional command?: string
Optional hears?: any
Optional poll?: any
Optional pollVote?: any
Optional prefix?: string | string[]
Optional reactions?: any
Optional upsert?: any

Accessors

args

get args(): string[]
Returns string[]
- Defined in src/Classes/Ctx.ts:67

bot

get bot(): ICtxSelf
Returns ICtxSelf
- Defined in src/Classes/Ctx.ts:47

core

get core(): {
    addChatLabel: ((jid, labelId) => Promise<void>);
    addLabel: ((jid, labels) => Promise<void>);
    addMessageLabel: ((jid, messageId, labelId) => Promise<void>);
    appPatch: ((patchCreate) => Promise<void>);
    assertSessions: ((jids, force) => Promise<boolean>);
    authState: {
        creds: AuthenticationCreds;
        keys: SignalKeyStoreWithTransaction;
    };
    chatModify: ((mod, jid) => Promise<void>);
    cleanDirtyBits: ((type, fromTimestamp?) => Promise<void>);
    createParticipantNodes: ((jids, message, extraAttrs?) => Promise<{
        nodes: BinaryNode[];
        shouldIncludeDeviceIdentity: boolean;
    }>);
    end: ((error) => void);
    ev: BaileysEventEmitter & {
        buffer() => void;
        createBufferedFunction<A, T_1>(work) => ((...args) => Promise<T_1>);
        flush(force?) => boolean;
        isBuffering() => boolean;
        process(handler) => (() => void);
    };
    executeUSyncQuery: ((usyncQuery) => Promise<undefined | USyncQueryResult>);
    fetchBlocklist: (() => Promise<string[]>);
    fetchDisappearingDuration: ((...jids) => Promise<undefined | USyncQueryResultList[]>);
    fetchMessageHistory: ((count, oldestMsgKey, oldestMsgTimestamp) => Promise<string>);
    fetchPrivacySettings: ((force?) => Promise<{
        [_: string]: string;
    }>);
    fetchStatus: ((...jids) => Promise<undefined | USyncQueryResultList[]>);
    generateMessageTag: (() => string);
    getBusinessProfile: ((jid) => Promise<void | WABusinessProfile>);
    getCatalog: ((__namedParameters) => Promise<{
        nextPageCursor: undefined | string;
        products: Product[];
    }>);
    getCollections: ((jid?, limit?) => Promise<{
        collections: CatalogCollection[];
    }>);
    getOrderDetails: ((orderId, tokenBase64) => Promise<OrderDetails>);
    getPrivacyTokens: ((jids) => Promise<BinaryNode>);
    getUSyncDevices: ((jids, useCache, ignoreZeroDevices) => Promise<JidWithDevice[]>);
    groupAcceptInvite: ((code) => Promise<undefined | string>);
    groupAcceptInviteV4: ((key, inviteMessage) => Promise<string>);
    groupCreate: ((subject, participants) => Promise<GroupMetadata>);
    groupFetchAllParticipating: (() => Promise<{
        [_: string]: GroupMetadata;
    }>);
    groupGetInviteInfo: ((code) => Promise<GroupMetadata>);
    groupInviteCode: ((jid) => Promise<undefined | string>);
    groupJoinApprovalMode: ((jid, mode) => Promise<void>);
    groupLeave: ((id) => Promise<void>);
    groupMemberAddMode: ((jid, mode) => Promise<void>);
    groupMetadata: ((jid) => Promise<GroupMetadata>);
    groupParticipantsUpdate: ((jid, participants, action) => Promise<{
        content: BinaryNode;
        jid: string;
        status: string;
    }[]>);
    groupRequestParticipantsList: ((jid) => Promise<{
        [key: string]: string;
    }[]>);
    groupRequestParticipantsUpdate: ((jid, participants, action) => Promise<{
        jid: string;
        status: string;
    }[]>);
    groupRevokeInvite: ((jid) => Promise<undefined | string>);
    groupRevokeInviteV4: ((groupJid, invitedJid) => Promise<boolean>);
    groupSettingUpdate: ((jid, setting) => Promise<void>);
    groupToggleEphemeral: ((jid, ephemeralExpiration) => Promise<void>);
    groupUpdateDescription: ((jid, description?) => Promise<void>);
    groupUpdateSubject: ((jid, subject) => Promise<void>);
    logger: ILogger;
    logout: ((msg?) => Promise<void>);
    onUnexpectedError: ((err, msg) => void);
    onWhatsApp: ((...jids) => Promise<undefined | {
        exists: unknown;
        jid: string;
    }[]>);
    presenceSubscribe: ((toJid, tcToken?) => Promise<void>);
    processingMutex: {
        mutex<T>(code) => Promise<T>;
    };
    productCreate: ((create) => Promise<Product>);
    productDelete: ((productIds) => Promise<{
        deleted: number;
    }>);
    productUpdate: ((productId, update) => Promise<Product>);
    profilePictureUrl: ((jid, type?, timeoutMs?) => Promise<undefined | string>);
    query: ((node, timeoutMs?) => Promise<BinaryNode>);
    readMessages: ((keys) => Promise<void>);
    refreshMediaConn: ((forceGet?) => Promise<MediaConnInfo>);
    rejectCall: ((callId, callFrom) => Promise<void>);
    relayMessage: ((jid, message, __namedParameters) => Promise<string>);
    removeChatLabel: ((jid, labelId) => Promise<void>);
    removeMessageLabel: ((jid, messageId, labelId) => Promise<void>);
    removeProfilePicture: ((jid) => Promise<void>);
    requestPairingCode: ((phoneNumber) => Promise<string>);
    requestPlaceholderResend: ((messageKey) => Promise<undefined | string>);
    resyncAppState: ((collections, isInitialSync) => Promise<void>);
    sendMessage: ((jid, content, options?) => Promise<undefined | WebMessageInfo>);
    sendMessageAck: ((__namedParameters, errorCode?) => Promise<void>);
    sendNode: ((frame) => Promise<void>);
    sendPeerDataOperationMessage: ((pdoMessage) => Promise<string>);
    sendPresenceUpdate: ((type, toJid?) => Promise<void>);
    sendRawMessage: ((data) => Promise<void>);
    sendReceipt: ((jid, participant, messageIds, type) => Promise<void>);
    sendReceipts: ((keys, type) => Promise<void>);
    sendRetryRequest: ((node, forceIncludeKeys?) => Promise<void>);
    sendWAMBuffer: ((wamBuffer) => Promise<BinaryNode>);
    signalRepository: SignalRepository;
    star: ((jid, messages, star) => Promise<void>);
    type: "md";
    updateBlockStatus: ((jid, action) => Promise<void>);
    updateCallPrivacy: ((value) => Promise<void>);
    updateDefaultDisappearingMode: ((duration) => Promise<void>);
    updateGroupsAddPrivacy: ((value) => Promise<void>);
    updateLastSeenPrivacy: ((value) => Promise<void>);
    updateMediaMessage: ((message) => Promise<IWebMessageInfo>);
    updateMessagesPrivacy: ((value) => Promise<void>);
    updateOnlinePrivacy: ((value) => Promise<void>);
    updateProfileName: ((name) => Promise<void>);
    updateProfilePicture: ((jid, content) => Promise<void>);
    updateProfilePicturePrivacy: ((value) => Promise<void>);
    updateProfileStatus: ((status) => Promise<void>);
    updateReadReceiptsPrivacy: ((value) => Promise<void>);
    updateStatusPrivacy: ((value) => Promise<void>);
    uploadPreKeys: ((count?) => Promise<void>);
    uploadPreKeysToServerIfRequired: (() => Promise<void>);
    upsertMessage: ((msg, type) => Promise<void>);
    user: undefined | Contact;
    waUploadToServer: WAMediaUploadFunction;
    waitForConnectionUpdate: ((check, timeoutMs?) => Promise<void>);
    waitForMessage: (<T_2>(msgId, timeoutMs?) => Promise<T_2>);
    waitForSocketOpen: (() => Promise<void>);
    ws: WebSocketClient;
}
Returns {
    addChatLabel: ((jid, labelId) => Promise<void>);
    addLabel: ((jid, labels) => Promise<void>);
    addMessageLabel: ((jid, messageId, labelId) => Promise<void>);
    appPatch: ((patchCreate) => Promise<void>);
    assertSessions: ((jids, force) => Promise<boolean>);
    authState: {
        creds: AuthenticationCreds;
        keys: SignalKeyStoreWithTransaction;
    };
    chatModify: ((mod, jid) => Promise<void>);
    cleanDirtyBits: ((type, fromTimestamp?) => Promise<void>);
    createParticipantNodes: ((jids, message, extraAttrs?) => Promise<{
        nodes: BinaryNode[];
        shouldIncludeDeviceIdentity: boolean;
    }>);
    end: ((error) => void);
    ev: BaileysEventEmitter & {
        buffer() => void;
        createBufferedFunction<A, T_1>(work) => ((...args) => Promise<T_1>);
        flush(force?) => boolean;
        isBuffering() => boolean;
        process(handler) => (() => void);
    };
    executeUSyncQuery: ((usyncQuery) => Promise<undefined | USyncQueryResult>);
    fetchBlocklist: (() => Promise<string[]>);
    fetchDisappearingDuration: ((...jids) => Promise<undefined | USyncQueryResultList[]>);
    fetchMessageHistory: ((count, oldestMsgKey, oldestMsgTimestamp) => Promise<string>);
    fetchPrivacySettings: ((force?) => Promise<{
        [_: string]: string;
    }>);
    fetchStatus: ((...jids) => Promise<undefined | USyncQueryResultList[]>);
    generateMessageTag: (() => string);
    getBusinessProfile: ((jid) => Promise<void | WABusinessProfile>);
    getCatalog: ((__namedParameters) => Promise<{
        nextPageCursor: undefined | string;
        products: Product[];
    }>);
    getCollections: ((jid?, limit?) => Promise<{
        collections: CatalogCollection[];
    }>);
    getOrderDetails: ((orderId, tokenBase64) => Promise<OrderDetails>);
    getPrivacyTokens: ((jids) => Promise<BinaryNode>);
    getUSyncDevices: ((jids, useCache, ignoreZeroDevices) => Promise<JidWithDevice[]>);
    groupAcceptInvite: ((code) => Promise<undefined | string>);
    groupAcceptInviteV4: ((key, inviteMessage) => Promise<string>);
    groupCreate: ((subject, participants) => Promise<GroupMetadata>);
    groupFetchAllParticipating: (() => Promise<{
        [_: string]: GroupMetadata;
    }>);
    groupGetInviteInfo: ((code) => Promise<GroupMetadata>);
    groupInviteCode: ((jid) => Promise<undefined | string>);
    groupJoinApprovalMode: ((jid, mode) => Promise<void>);
    groupLeave: ((id) => Promise<void>);
    groupMemberAddMode: ((jid, mode) => Promise<void>);
    groupMetadata: ((jid) => Promise<GroupMetadata>);
    groupParticipantsUpdate: ((jid, participants, action) => Promise<{
        content: BinaryNode;
        jid: string;
        status: string;
    }[]>);
    groupRequestParticipantsList: ((jid) => Promise<{
        [key: string]: string;
    }[]>);
    groupRequestParticipantsUpdate: ((jid, participants, action) => Promise<{
        jid: string;
        status: string;
    }[]>);
    groupRevokeInvite: ((jid) => Promise<undefined | string>);
    groupRevokeInviteV4: ((groupJid, invitedJid) => Promise<boolean>);
    groupSettingUpdate: ((jid, setting) => Promise<void>);
    groupToggleEphemeral: ((jid, ephemeralExpiration) => Promise<void>);
    groupUpdateDescription: ((jid, description?) => Promise<void>);
    groupUpdateSubject: ((jid, subject) => Promise<void>);
    logger: ILogger;
    logout: ((msg?) => Promise<void>);
    onUnexpectedError: ((err, msg) => void);
    onWhatsApp: ((...jids) => Promise<undefined | {
        exists: unknown;
        jid: string;
    }[]>);
    presenceSubscribe: ((toJid, tcToken?) => Promise<void>);
    processingMutex: {
        mutex<T>(code) => Promise<T>;
    };
    productCreate: ((create) => Promise<Product>);
    productDelete: ((productIds) => Promise<{
        deleted: number;
    }>);
    productUpdate: ((productId, update) => Promise<Product>);
    profilePictureUrl: ((jid, type?, timeoutMs?) => Promise<undefined | string>);
    query: ((node, timeoutMs?) => Promise<BinaryNode>);
    readMessages: ((keys) => Promise<void>);
    refreshMediaConn: ((forceGet?) => Promise<MediaConnInfo>);
    rejectCall: ((callId, callFrom) => Promise<void>);
    relayMessage: ((jid, message, __namedParameters) => Promise<string>);
    removeChatLabel: ((jid, labelId) => Promise<void>);
    removeMessageLabel: ((jid, messageId, labelId) => Promise<void>);
    removeProfilePicture: ((jid) => Promise<void>);
    requestPairingCode: ((phoneNumber) => Promise<string>);
    requestPlaceholderResend: ((messageKey) => Promise<undefined | string>);
    resyncAppState: ((collections, isInitialSync) => Promise<void>);
    sendMessage: ((jid, content, options?) => Promise<undefined | WebMessageInfo>);
    sendMessageAck: ((__namedParameters, errorCode?) => Promise<void>);
    sendNode: ((frame) => Promise<void>);
    sendPeerDataOperationMessage: ((pdoMessage) => Promise<string>);
    sendPresenceUpdate: ((type, toJid?) => Promise<void>);
    sendRawMessage: ((data) => Promise<void>);
    sendReceipt: ((jid, participant, messageIds, type) => Promise<void>);
    sendReceipts: ((keys, type) => Promise<void>);
    sendRetryRequest: ((node, forceIncludeKeys?) => Promise<void>);
    sendWAMBuffer: ((wamBuffer) => Promise<BinaryNode>);
    signalRepository: SignalRepository;
    star: ((jid, messages, star) => Promise<void>);
    type: "md";
    updateBlockStatus: ((jid, action) => Promise<void>);
    updateCallPrivacy: ((value) => Promise<void>);
    updateDefaultDisappearingMode: ((duration) => Promise<void>);
    updateGroupsAddPrivacy: ((value) => Promise<void>);
    updateLastSeenPrivacy: ((value) => Promise<void>);
    updateMediaMessage: ((message) => Promise<IWebMessageInfo>);
    updateMessagesPrivacy: ((value) => Promise<void>);
    updateOnlinePrivacy: ((value) => Promise<void>);
    updateProfileName: ((name) => Promise<void>);
    updateProfilePicture: ((jid, content) => Promise<void>);
    updateProfilePicturePrivacy: ((value) => Promise<void>);
    updateProfileStatus: ((status) => Promise<void>);
    updateReadReceiptsPrivacy: ((value) => Promise<void>);
    updateStatusPrivacy: ((value) => Promise<void>);
    uploadPreKeys: ((count?) => Promise<void>);
    uploadPreKeysToServerIfRequired: (() => Promise<void>);
    upsertMessage: ((msg, type) => Promise<void>);
    user: undefined | Contact;
    waUploadToServer: WAMediaUploadFunction;
    waitForConnectionUpdate: ((check, timeoutMs?) => Promise<void>);
    waitForMessage: (<T_2>(msgId, timeoutMs?) => Promise<T_2>);
    waitForSocketOpen: (() => Promise<void>);
    ws: WebSocketClient;
}
- addChatLabel: ((jid, labelId) => Promise<void>)
  - - (jid, labelId): Promise<void>
    - Parameters
      
      jid: string
      
      labelId: string
      Returns Promise<void>
- addLabel: ((jid, labels) => Promise<void>)
  - - (jid, labels): Promise<void>
    - Parameters
      
      jid: string
      
      labels: LabelActionBody
      Returns Promise<void>
- addMessageLabel: ((jid, messageId, labelId) => Promise<void>)
  - - (jid, messageId, labelId): Promise<void>
    - Parameters
      
      jid: string
      
      messageId: string
      
      labelId: string
      Returns Promise<void>
- appPatch: ((patchCreate) => Promise<void>)
  - - (patchCreate): Promise<void>
    - Parameters
      
      patchCreate: WAPatchCreate
      Returns Promise<void>
- assertSessions: ((jids, force) => Promise<boolean>)
  - - (jids, force): Promise<boolean>
    - Parameters
      
      jids: string[]
      
      force: boolean
      Returns Promise<boolean>
- authState: {
  creds: AuthenticationCreds;
  keys: SignalKeyStoreWithTransaction;
  }
  - creds: AuthenticationCreds
  - keys: SignalKeyStoreWithTransaction
- chatModify: ((mod, jid) => Promise<void>)
  - - (mod, jid): Promise<void>
    - Parameters
      
      mod: ChatModification
      
      jid: string
      Returns Promise<void>
- cleanDirtyBits: ((type, fromTimestamp?) => Promise<void>)
  - - (type, fromTimestamp?): Promise<void>
    - Parameters
      
      type: "account_sync" | "groups"
      
      Optional fromTimestamp: string | number
      Returns Promise<void>
- createParticipantNodes: ((jids, message, extraAttrs?) => Promise<{
  nodes: BinaryNode[];
  shouldIncludeDeviceIdentity: boolean;
  }>)
  - - (jids, message, extraAttrs?): Promise<{
      nodes: BinaryNode[];
      shouldIncludeDeviceIdentity: boolean;
      }>
    - Parameters
      
      jids: string[]
      
      message: IMessage
      
      Optional extraAttrs: {
      [key: string]: string;
      }
      
      [key: string]: string
      Returns Promise<{
      nodes: BinaryNode[];
      shouldIncludeDeviceIdentity: boolean;
      }>
- end: ((error) => void)
  - - (error): void
    - Parameters
      
      error: undefined | Error
      Returns void
- ev: BaileysEventEmitter & {
      buffer() => void;
      createBufferedFunction<A, T_1>(work) => ((...args) => Promise<T_1>);
      flush(force?) => boolean;
      isBuffering() => boolean;
      process(handler) => (() => void);
  }
- executeUSyncQuery: ((usyncQuery) => Promise<undefined | USyncQueryResult>)
  - - (usyncQuery): Promise<undefined | USyncQueryResult>
    - Parameters
      
      usyncQuery: USyncQuery
      Returns Promise<undefined | USyncQueryResult>
- fetchBlocklist: (() => Promise<string[]>)
  - - (): Promise<string[]>
    - Returns Promise<string[]>
- fetchDisappearingDuration: ((...jids) => Promise<undefined | USyncQueryResultList[]>)
  - - (...jids): Promise<undefined | USyncQueryResultList[]>
    - Parameters
      
      Rest ...jids: string[]
      Returns Promise<undefined | USyncQueryResultList[]>
- fetchMessageHistory: ((count, oldestMsgKey, oldestMsgTimestamp) => Promise<string>)
  - - (count, oldestMsgKey, oldestMsgTimestamp): Promise<string>
    - Parameters
      
      count: number
      
      oldestMsgKey: IMessageKey
      
      oldestMsgTimestamp: any
      Returns Promise<string>
- fetchPrivacySettings: ((force?) => Promise<{
  [_: string]: string;
  }>)
  - - (force?): Promise<{
      [_: string]: string;
      }>
    - Parameters
      
      Optional force: boolean
      Returns Promise<{
      [_: string]: string;
      }>
- fetchStatus: ((...jids) => Promise<undefined | USyncQueryResultList[]>)
  - - (...jids): Promise<undefined | USyncQueryResultList[]>
    - Parameters
      
      Rest ...jids: string[]
      Returns Promise<undefined | USyncQueryResultList[]>
- generateMessageTag: (() => string)
  - - (): string
    - Returns string
- getBusinessProfile: ((jid) => Promise<void | WABusinessProfile>)
  - - (jid): Promise<void | WABusinessProfile>
    - Parameters
      
      jid: string
      Returns Promise<void | WABusinessProfile>
- getCatalog: ((__namedParameters) => Promise<{
  nextPageCursor: undefined | string;
  products: Product[];
  }>)
  - - (__namedParameters): Promise<{
      nextPageCursor: undefined | string;
      products: Product[];
      }>
    - Parameters
      
      __namedParameters: GetCatalogOptions
      Returns Promise<{
      nextPageCursor: undefined | string;
      products: Product[];
      }>
- getCollections: ((jid?, limit?) => Promise<{
  collections: CatalogCollection[];
  }>)
  - - (jid?, limit?): Promise<{
      collections: CatalogCollection[];
      }>
    - Parameters
      
      Optional jid: string
      
      Optional limit: number
      Returns Promise<{
      collections: CatalogCollection[];
      }>
- getOrderDetails: ((orderId, tokenBase64) => Promise<OrderDetails>)
  - - (orderId, tokenBase64): Promise<OrderDetails>
    - Parameters
      
      orderId: string
      
      tokenBase64: string
      Returns Promise<OrderDetails>
- getPrivacyTokens: ((jids) => Promise<BinaryNode>)
  - - (jids): Promise<BinaryNode>
    - Parameters
      
      jids: string[]
      Returns Promise<BinaryNode>
- getUSyncDevices: ((jids, useCache, ignoreZeroDevices) => Promise<JidWithDevice[]>)
  - - (jids, useCache, ignoreZeroDevices): Promise<JidWithDevice[]>
    - Parameters
      
      jids: string[]
      
      useCache: boolean
      
      ignoreZeroDevices: boolean
      Returns Promise<JidWithDevice[]>
- groupAcceptInvite: ((code) => Promise<undefined | string>)
  - - (code): Promise<undefined | string>
    - Parameters
      
      code: string
      Returns Promise<undefined | string>
- groupAcceptInviteV4: ((key, inviteMessage) => Promise<string>)
  - - (key, inviteMessage): Promise<string>
    - Parameters
      
      key: string | IMessageKey
      
      inviteMessage: IGroupInviteMessage
      Returns Promise<string>
- groupCreate: ((subject, participants) => Promise<GroupMetadata>)
  - - (subject, participants): Promise<GroupMetadata>
    - Parameters
      
      subject: string
      
      participants: string[]
      Returns Promise<GroupMetadata>
- groupFetchAllParticipating: (() => Promise<{
  [_: string]: GroupMetadata;
  }>)
  - - (): Promise<{
      [_: string]: GroupMetadata;
      }>
    - Returns Promise<{
      [_: string]: GroupMetadata;
      }>
- groupGetInviteInfo: ((code) => Promise<GroupMetadata>)
  - - (code): Promise<GroupMetadata>
    - Parameters
      
      code: string
      Returns Promise<GroupMetadata>
- groupInviteCode: ((jid) => Promise<undefined | string>)
  - - (jid): Promise<undefined | string>
    - Parameters
      
      jid: string
      Returns Promise<undefined | string>
- groupJoinApprovalMode: ((jid, mode) => Promise<void>)
  - - (jid, mode): Promise<void>
    - Parameters
      
      jid: string
      
      mode: "on" | "off"
      Returns Promise<void>
- groupLeave: ((id) => Promise<void>)
  - - (id): Promise<void>
    - Parameters
      
      id: string
      Returns Promise<void>
- groupMemberAddMode: ((jid, mode) => Promise<void>)
  - - (jid, mode): Promise<void>
    - Parameters
      
      jid: string
      
      mode: "all_member_add" | "admin_add"
      Returns Promise<void>
- groupMetadata: ((jid) => Promise<GroupMetadata>)
  - - (jid): Promise<GroupMetadata>
    - Parameters
      
      jid: string
      Returns Promise<GroupMetadata>
- groupParticipantsUpdate: ((jid, participants, action) => Promise<{
      content: BinaryNode;
      jid: string;
      status: string;
  }[]>)
  - - (jid, participants, action): Promise<{
          content: BinaryNode;
          jid: string;
          status: string;
      }[]>
    - Parameters
      
      jid: string
      
      participants: string[]
      
      action: ParticipantAction
      Returns Promise<{
          content: BinaryNode;
          jid: string;
          status: string;
      }[]>
- groupRequestParticipantsList: ((jid) => Promise<{
  [key: string]: string;
  }[]>)
  - - (jid): Promise<{
      [key: string]: string;
      }[]>
    - Parameters
      
      jid: string
      Returns Promise<{
      [key: string]: string;
      }[]>
- groupRequestParticipantsUpdate: ((jid, participants, action) => Promise<{
  jid: string;
  status: string;
  }[]>)
  - - (jid, participants, action): Promise<{
      jid: string;
      status: string;
      }[]>
    - Parameters
      
      jid: string
      
      participants: string[]
      
      action: "reject" | "approve"
      Returns Promise<{
      jid: string;
      status: string;
      }[]>
- groupRevokeInvite: ((jid) => Promise<undefined | string>)
  - - (jid): Promise<undefined | string>
    - Parameters
      
      jid: string
      Returns Promise<undefined | string>
- groupRevokeInviteV4: ((groupJid, invitedJid) => Promise<boolean>)
  - - (groupJid, invitedJid): Promise<boolean>
    - Parameters
      
      groupJid: string
      
      invitedJid: string
      Returns Promise<boolean>
- groupSettingUpdate: ((jid, setting) => Promise<void>)
  - - (jid, setting): Promise<void>
    - Parameters
      
      jid: string
      
      setting: "announcement" | "not_announcement" | "locked" | "unlocked"
      Returns Promise<void>
- groupToggleEphemeral: ((jid, ephemeralExpiration) => Promise<void>)
  - - (jid, ephemeralExpiration): Promise<void>
    - Parameters
      
      jid: string
      
      ephemeralExpiration: number
      Returns Promise<void>
- groupUpdateDescription: ((jid, description?) => Promise<void>)
  - - (jid, description?): Promise<void>
    - Parameters
      
      jid: string
      
      Optional description: string
      Returns Promise<void>
- groupUpdateSubject: ((jid, subject) => Promise<void>)
  - - (jid, subject): Promise<void>
    - Parameters
      
      jid: string
      
      subject: string
      Returns Promise<void>
- logger: ILogger
- logout: ((msg?) => Promise<void>)
  - - (msg?): Promise<void>
    - Parameters
      
      Optional msg: string
      Returns Promise<void>
- onUnexpectedError: ((err, msg) => void)
  - - (err, msg): void
    - Parameters
      
      err: Error | Boom<any>
      
      msg: string
      Returns void
- onWhatsApp: ((...jids) => Promise<undefined | {
  exists: unknown;
  jid: string;
  }[]>)
  - - (...jids): Promise<undefined | {
      exists: unknown;
      jid: string;
      }[]>
    - Parameters
      
      Rest ...jids: string[]
      Returns Promise<undefined | {
      exists: unknown;
      jid: string;
      }[]>
- presenceSubscribe: ((toJid, tcToken?) => Promise<void>)
  - - (toJid, tcToken?): Promise<void>
    - Parameters
      
      toJid: string
      
      Optional tcToken: Buffer
      Returns Promise<void>
- processingMutex: {
  mutex<T>(code) => Promise<T>;
  }
  - mutex:function
    - mutex<T>(code): Promise<T>
    - Type Parameters
      
      T
      Parameters
      
      code: (() => T | Promise<T>)
      
      (): T | Promise<T>
      
      Returns T | Promise<T>
      Returns Promise<T>
      Defined in node_modules/.pnpm/@whiskeysockets+baileys@6.7_f966cb5c9a5266cd5f6d91ebdf31ebe4/node_modules/@whiskeysockets/baileys/lib/Socket/index.d.ts:77
- productCreate: ((create) => Promise<Product>)
  - - (create): Promise<Product>
    - Parameters
      
      create: ProductCreate
      Returns Promise<Product>
- productDelete: ((productIds) => Promise<{
  deleted: number;
  }>)
  - - (productIds): Promise<{
      deleted: number;
      }>
    - Parameters
      
      productIds: string[]
      Returns Promise<{
      deleted: number;
      }>
- productUpdate: ((productId, update) => Promise<Product>)
  - - (productId, update): Promise<Product>
    - Parameters
      
      productId: string
      
      update: ProductUpdate
      Returns Promise<Product>
- profilePictureUrl: ((jid, type?, timeoutMs?) => Promise<undefined | string>)
  - - (jid, type?, timeoutMs?): Promise<undefined | string>
    - Parameters
      
      jid: string
      
      Optional type: "image" | "preview"
      
      Optional timeoutMs: number
      Returns Promise<undefined | string>
- query: ((node, timeoutMs?) => Promise<BinaryNode>)
  - - (node, timeoutMs?): Promise<BinaryNode>
    - Parameters
      
      node: BinaryNode
      
      Optional timeoutMs: number
      Returns Promise<BinaryNode>
- readMessages: ((keys) => Promise<void>)
  - - (keys): Promise<void>
    - Parameters
      
      keys: IMessageKey[]
      Returns Promise<void>
- refreshMediaConn: ((forceGet?) => Promise<MediaConnInfo>)
  - - (forceGet?): Promise<MediaConnInfo>
    - Parameters
      
      Optional forceGet: boolean
      Returns Promise<MediaConnInfo>
- rejectCall: ((callId, callFrom) => Promise<void>)
  - - (callId, callFrom): Promise<void>
    - Parameters
      
      callId: string
      
      callFrom: string
      Returns Promise<void>
- relayMessage: ((jid, message, __namedParameters) => Promise<string>)
  - - (jid, message, __namedParameters): Promise<string>
    - Parameters
      
      jid: string
      
      message: IMessage
      
      __namedParameters: MessageRelayOptions
      Returns Promise<string>
- removeChatLabel: ((jid, labelId) => Promise<void>)
  - - (jid, labelId): Promise<void>
    - Parameters
      
      jid: string
      
      labelId: string
      Returns Promise<void>
- removeMessageLabel: ((jid, messageId, labelId) => Promise<void>)
  - - (jid, messageId, labelId): Promise<void>
    - Parameters
      
      jid: string
      
      messageId: string
      
      labelId: string
      Returns Promise<void>
- removeProfilePicture: ((jid) => Promise<void>)
  - - (jid): Promise<void>
    - Parameters
      
      jid: string
      Returns Promise<void>
- requestPairingCode: ((phoneNumber) => Promise<string>)
  - - (phoneNumber): Promise<string>
    - Parameters
      
      phoneNumber: string
      Returns Promise<string>
- requestPlaceholderResend: ((messageKey) => Promise<undefined | string>)
  - - (messageKey): Promise<undefined | string>
    - Parameters
      
      messageKey: IMessageKey
      Returns Promise<undefined | string>
- resyncAppState: ((collections, isInitialSync) => Promise<void>)
  - - (collections, isInitialSync): Promise<void>
    - Parameters
      
      collections: readonly ("critical_block" | "critical_unblock_low" | "regular_high" | "regular_low" | "regular")[]
      
      isInitialSync: boolean
      Returns Promise<void>
- sendMessage: ((jid, content, options?) => Promise<undefined | WebMessageInfo>)
  - - (jid, content, options?): Promise<undefined | WebMessageInfo>
    - Parameters
      
      jid: string
      
      content: AnyMessageContent
      
      Optional options: MiscMessageGenerationOptions
      Returns Promise<undefined | WebMessageInfo>
- sendMessageAck: ((__namedParameters, errorCode?) => Promise<void>)
  - - (__namedParameters, errorCode?): Promise<void>
    - Parameters
      
      __namedParameters: BinaryNode
      
      Optional errorCode: number
      Returns Promise<void>
- sendNode: ((frame) => Promise<void>)
  - - (frame): Promise<void>
    - Parameters
      
      frame: BinaryNode
      Returns Promise<void>
- sendPeerDataOperationMessage: ((pdoMessage) => Promise<string>)
  - - (pdoMessage): Promise<string>
    - Parameters
      
      pdoMessage: IPeerDataOperationRequestMessage
      Returns Promise<string>
- sendPresenceUpdate: ((type, toJid?) => Promise<void>)
  - - (type, toJid?): Promise<void>
    - Parameters
      
      type: WAPresence
      
      Optional toJid: string
      Returns Promise<void>
- sendRawMessage: ((data) => Promise<void>)
  - - (data): Promise<void>
    - Parameters
      
      data: Buffer | Uint8Array
      Returns Promise<void>
- sendReceipt: ((jid, participant, messageIds, type) => Promise<void>)
  - - (jid, participant, messageIds, type): Promise<void>
    - Parameters
      
      jid: string
      
      participant: undefined | string
      
      messageIds: string[]
      
      type: MessageReceiptType
      Returns Promise<void>
- sendReceipts: ((keys, type) => Promise<void>)
  - - (keys, type): Promise<void>
    - Parameters
      
      keys: IMessageKey[]
      
      type: MessageReceiptType
      Returns Promise<void>
- sendRetryRequest: ((node, forceIncludeKeys?) => Promise<void>)
  - - (node, forceIncludeKeys?): Promise<void>
    - Parameters
      
      node: BinaryNode
      
      Optional forceIncludeKeys: boolean
      Returns Promise<void>
- sendWAMBuffer: ((wamBuffer) => Promise<BinaryNode>)
  - - (wamBuffer): Promise<BinaryNode>
    - Parameters
      
      wamBuffer: Buffer
      Returns Promise<BinaryNode>
- signalRepository: SignalRepository
- star: ((jid, messages, star) => Promise<void>)
  - - (jid, messages, star): Promise<void>
    - Parameters
      
      jid: string
      
      messages: {
      fromMe?: boolean;
      id: string;
      }[]
      
      star: boolean
      Returns Promise<void>
- type: "md"
- updateBlockStatus: ((jid, action) => Promise<void>)
  - - (jid, action): Promise<void>
    - Parameters
      
      jid: string
      
      action: "block" | "unblock"
      Returns Promise<void>
- updateCallPrivacy: ((value) => Promise<void>)
  - - (value): Promise<void>
    - Parameters
      
      value: WAPrivacyCallValue
      Returns Promise<void>
- updateDefaultDisappearingMode: ((duration) => Promise<void>)
  - - (duration): Promise<void>
    - Parameters
      
      duration: number
      Returns Promise<void>
- updateGroupsAddPrivacy: ((value) => Promise<void>)
  - - (value): Promise<void>
    - Parameters
      
      value: WAPrivacyGroupAddValue
      Returns Promise<void>
- updateLastSeenPrivacy: ((value) => Promise<void>)
  - - (value): Promise<void>
    - Parameters
      
      value: WAPrivacyValue
      Returns Promise<void>
- updateMediaMessage: ((message) => Promise<IWebMessageInfo>)
  - - (message): Promise<IWebMessageInfo>
    - Parameters
      
      message: IWebMessageInfo
      Returns Promise<IWebMessageInfo>
- updateMessagesPrivacy: ((value) => Promise<void>)
  - - (value): Promise<void>
    - Parameters
      
      value: WAPrivacyMessagesValue
      Returns Promise<void>
- updateOnlinePrivacy: ((value) => Promise<void>)
  - - (value): Promise<void>
    - Parameters
      
      value: WAPrivacyOnlineValue
      Returns Promise<void>
- updateProfileName: ((name) => Promise<void>)
  - - (name): Promise<void>
    - Parameters
      
      name: string
      Returns Promise<void>
- updateProfilePicture: ((jid, content) => Promise<void>)
  - - (jid, content): Promise<void>
    - Parameters
      
      jid: string
      
      content: WAMediaUpload
      Returns Promise<void>
- updateProfilePicturePrivacy: ((value) => Promise<void>)
  - - (value): Promise<void>
    - Parameters
      
      value: WAPrivacyValue
      Returns Promise<void>
- updateProfileStatus: ((status) => Promise<void>)
  - - (status): Promise<void>
    - Parameters
      
      status: string
      Returns Promise<void>
- updateReadReceiptsPrivacy: ((value) => Promise<void>)
  - - (value): Promise<void>
    - Parameters
      
      value: WAReadReceiptsValue
      Returns Promise<void>
- updateStatusPrivacy: ((value) => Promise<void>)
  - - (value): Promise<void>
    - Parameters
      
      value: WAPrivacyValue
      Returns Promise<void>
- uploadPreKeys: ((count?) => Promise<void>)
  - - (count?): Promise<void>
    - Parameters
      
      Optional count: number
      Returns Promise<void>
- uploadPreKeysToServerIfRequired: (() => Promise<void>)
  - - (): Promise<void>
    - Returns Promise<void>
- upsertMessage: ((msg, type) => Promise<void>)
  - - (msg, type): Promise<void>
    - Parameters
      
      msg: IWebMessageInfo
      
      type: MessageUpsertType
      Returns Promise<void>
- user: undefined | Contact
- waUploadToServer: WAMediaUploadFunction
- waitForConnectionUpdate: ((check, timeoutMs?) => Promise<void>)
  - - (check, timeoutMs?): Promise<void>
    - Parameters
      
      check: ((u) => Promise<undefined | boolean>)
      
      (u): Promise<undefined | boolean>
      
      Parameters
      
      u: Partial<ConnectionState>
      
      Returns Promise<undefined | boolean>
      
      Optional timeoutMs: number
      Returns Promise<void>
- waitForMessage: (<T_2>(msgId, timeoutMs?) => Promise<T_2>)
  - - <T_2>(msgId, timeoutMs?): Promise<T_2>
    - Type Parameters
      
      T_2
      Parameters
      
      msgId: string
      
      Optional timeoutMs: number
      Returns Promise<T_2>
- waitForSocketOpen: (() => Promise<void>)
  - - (): Promise<void>
    - Returns Promise<void>
- ws: WebSocketClient
- Defined in src/Classes/Ctx.ts:59

decodedId

get decodedId(): undefined | null | string
Returns undefined | null | string
- Defined in src/Classes/Ctx.ts:63

groups

get groups(): Group
Returns Group
- Defined in src/Classes/Ctx.ts:231

id

get id(): undefined | null | string
Returns undefined | null | string
- Defined in src/Classes/Ctx.ts:39

me

get me(): IMe
Returns IMe
- Defined in src/Classes/Ctx.ts:51

msg

get msg(): {
    agentId?: null | string;
    bizPrivacyStatus?: null | BizPrivacyStatus;
    botMessageInvokerJid?: null | string;
    broadcast?: null | boolean;
    clearMedia?: null | boolean;
    commentMetadata?: null | ICommentMetadata;
    content: undefined | null | string;
    duration?: null | number;
    ephemeralDuration?: null | number;
    ephemeralOffToOn?: null | boolean;
    ephemeralOutOfSync?: null | boolean;
    ephemeralStartTimestamp?: any;
    eventResponses?: null | IEventResponse[];
    finalLiveLocation?: null | ILiveLocationMessage;
    futureproofData?: null | Uint8Array;
    ignore?: null | boolean;
    is1PBizBotMessage?: null | boolean;
    isGroupHistoryMessage?: null | boolean;
    keepInChat?: null | IKeepInChat;
    key: IMessageKey;
    labels?: null | string[];
    media: {
        toBuffer: (() => Promise<null | Buffer | Transform>);
        toStream: (() => Promise<null | Buffer | Transform>);
    };
    mediaCiphertextSha256?: null | Uint8Array;
    mediaData?: null | IMediaData;
    message?: null | IMessage;
    messageC2STimestamp?: any;
    messageSecret?: null | Uint8Array;
    messageStubParameters?: null | string[];
    messageStubType?: null | StubType;
    messageTimestamp?: any;
    messageType: undefined | keyof IMessage;
    multicast?: null | boolean;
    newsletterServerId?: any;
    originalSelfAuthorUserJidString?: null | string;
    participant?: null | string;
    paymentInfo?: null | IPaymentInfo;
    photoChange?: null | IPhotoChange;
    pinInChat?: null | IPinInChat;
    pollAdditionalMetadata?: null | IPollAdditionalMetadata;
    pollSingleSelect?: boolean;
    pollUpdates?: null | IPollUpdate[];
    pollValues?: string[];
    premiumMessageInfo?: null | IPremiumMessageInfo;
    pushName?: null | string;
    quotedPaymentInfo?: null | IPaymentInfo;
    quotedStickerData?: null | IMediaData;
    reactions?: null | IReaction[];
    reportingTokenInfo?: null | IReportingTokenInfo;
    revokeMessageTimestamp?: any;
    starred?: null | boolean;
    status?: null | Status;
    statusAlreadyViewed?: null | boolean;
    statusPsa?: null | IStatusPSA;
    urlNumber?: null | boolean;
    urlText?: null | boolean;
    userReceipt?: null | IUserReceipt[];
    verifiedBizName?: null | string;
}
Returns {
    agentId?: null | string;
    bizPrivacyStatus?: null | BizPrivacyStatus;
    botMessageInvokerJid?: null | string;
    broadcast?: null | boolean;
    clearMedia?: null | boolean;
    commentMetadata?: null | ICommentMetadata;
    content: undefined | null | string;
    duration?: null | number;
    ephemeralDuration?: null | number;
    ephemeralOffToOn?: null | boolean;
    ephemeralOutOfSync?: null | boolean;
    ephemeralStartTimestamp?: any;
    eventResponses?: null | IEventResponse[];
    finalLiveLocation?: null | ILiveLocationMessage;
    futureproofData?: null | Uint8Array;
    ignore?: null | boolean;
    is1PBizBotMessage?: null | boolean;
    isGroupHistoryMessage?: null | boolean;
    keepInChat?: null | IKeepInChat;
    key: IMessageKey;
    labels?: null | string[];
    media: {
        toBuffer: (() => Promise<null | Buffer | Transform>);
        toStream: (() => Promise<null | Buffer | Transform>);
    };
    mediaCiphertextSha256?: null | Uint8Array;
    mediaData?: null | IMediaData;
    message?: null | IMessage;
    messageC2STimestamp?: any;
    messageSecret?: null | Uint8Array;
    messageStubParameters?: null | string[];
    messageStubType?: null | StubType;
    messageTimestamp?: any;
    messageType: undefined | keyof IMessage;
    multicast?: null | boolean;
    newsletterServerId?: any;
    originalSelfAuthorUserJidString?: null | string;
    participant?: null | string;
    paymentInfo?: null | IPaymentInfo;
    photoChange?: null | IPhotoChange;
    pinInChat?: null | IPinInChat;
    pollAdditionalMetadata?: null | IPollAdditionalMetadata;
    pollSingleSelect?: boolean;
    pollUpdates?: null | IPollUpdate[];
    pollValues?: string[];
    premiumMessageInfo?: null | IPremiumMessageInfo;
    pushName?: null | string;
    quotedPaymentInfo?: null | IPaymentInfo;
    quotedStickerData?: null | IMediaData;
    reactions?: null | IReaction[];
    reportingTokenInfo?: null | IReportingTokenInfo;
    revokeMessageTimestamp?: any;
    starred?: null | boolean;
    status?: null | Status;
    statusAlreadyViewed?: null | boolean;
    statusPsa?: null | IStatusPSA;
    urlNumber?: null | boolean;
    urlText?: null | boolean;
    userReceipt?: null | IUserReceipt[];
    verifiedBizName?: null | string;
}
- Optional agentId?: null | string
  
  WebMessageInfo agentId
- Optional bizPrivacyStatus?: null | BizPrivacyStatus
  
  WebMessageInfo bizPrivacyStatus
- Optional botMessageInvokerJid?: null | string
  
  WebMessageInfo botMessageInvokerJid
- Optional broadcast?: null | boolean
  
  WebMessageInfo broadcast
- Optional clearMedia?: null | boolean
  
  WebMessageInfo clearMedia
- Optional commentMetadata?: null | ICommentMetadata
  
  WebMessageInfo commentMetadata
- content: undefined | null | string
- Optional duration?: null | number
  
  WebMessageInfo duration
- Optional ephemeralDuration?: null | number
  
  WebMessageInfo ephemeralDuration
- Optional ephemeralOffToOn?: null | boolean
  
  WebMessageInfo ephemeralOffToOn
- Optional ephemeralOutOfSync?: null | boolean
  
  WebMessageInfo ephemeralOutOfSync
- Optional ephemeralStartTimestamp?: any
  
  WebMessageInfo ephemeralStartTimestamp
- Optional eventResponses?: null | IEventResponse[]
  
  WebMessageInfo eventResponses
- Optional finalLiveLocation?: null | ILiveLocationMessage
  
  WebMessageInfo finalLiveLocation
- Optional futureproofData?: null | Uint8Array
  
  WebMessageInfo futureproofData
- Optional ignore?: null | boolean
  
  WebMessageInfo ignore
- Optional is1PBizBotMessage?: null | boolean
  
  WebMessageInfo is1PBizBotMessage
- Optional isGroupHistoryMessage?: null | boolean
  
  WebMessageInfo isGroupHistoryMessage
- Optional keepInChat?: null | IKeepInChat
  
  WebMessageInfo keepInChat
- key: IMessageKey
  
  WebMessageInfo key
- Optional labels?: null | string[]
  
  WebMessageInfo labels
- media: {
  toBuffer: (() => Promise<null | Buffer | Transform>);
  toStream: (() => Promise<null | Buffer | Transform>);
  }
  - toBuffer: (() => Promise<null | Buffer | Transform>)
    - - (): Promise<null | Buffer | Transform>
      - Returns Promise<null | Buffer | Transform>
  - toStream: (() => Promise<null | Buffer | Transform>)
    - - (): Promise<null | Buffer | Transform>
      - Returns Promise<null | Buffer | Transform>
- Optional mediaCiphertextSha256?: null | Uint8Array
  
  WebMessageInfo mediaCiphertextSha256
- Optional mediaData?: null | IMediaData
  
  WebMessageInfo mediaData
- Optional message?: null | IMessage
  
  WebMessageInfo message
- Optional messageC2STimestamp?: any
  
  WebMessageInfo messageC2STimestamp
- Optional messageSecret?: null | Uint8Array
  
  WebMessageInfo messageSecret
- Optional messageStubParameters?: null | string[]
  
  WebMessageInfo messageStubParameters
- Optional messageStubType?: null | StubType
  
  WebMessageInfo messageStubType
- Optional messageTimestamp?: any
  
  WebMessageInfo messageTimestamp
- messageType: undefined | keyof IMessage
- Optional multicast?: null | boolean
  
  WebMessageInfo multicast
- Optional newsletterServerId?: any
  
  WebMessageInfo newsletterServerId
- Optional originalSelfAuthorUserJidString?: null | string
  
  WebMessageInfo originalSelfAuthorUserJidString
- Optional participant?: null | string
  
  WebMessageInfo participant
- Optional paymentInfo?: null | IPaymentInfo
  
  WebMessageInfo paymentInfo
- Optional photoChange?: null | IPhotoChange
  
  WebMessageInfo photoChange
- Optional pinInChat?: null | IPinInChat
  
  WebMessageInfo pinInChat
- Optional pollAdditionalMetadata?: null | IPollAdditionalMetadata
  
  WebMessageInfo pollAdditionalMetadata
- Optional pollSingleSelect?: boolean
- Optional pollUpdates?: null | IPollUpdate[]
  
  WebMessageInfo pollUpdates
- Optional pollValues?: string[]
- Optional premiumMessageInfo?: null | IPremiumMessageInfo
  
  WebMessageInfo premiumMessageInfo
- Optional pushName?: null | string
  
  WebMessageInfo pushName
- Optional quotedPaymentInfo?: null | IPaymentInfo
  
  WebMessageInfo quotedPaymentInfo
- Optional quotedStickerData?: null | IMediaData
  
  WebMessageInfo quotedStickerData
- Optional reactions?: null | IReaction[]
  
  WebMessageInfo reactions
- Optional reportingTokenInfo?: null | IReportingTokenInfo
  
  WebMessageInfo reportingTokenInfo
- Optional revokeMessageTimestamp?: any
  
  WebMessageInfo revokeMessageTimestamp
- Optional starred?: null | boolean
  
  WebMessageInfo starred
- Optional status?: null | Status
  
  WebMessageInfo status
- Optional statusAlreadyViewed?: null | boolean
  
  WebMessageInfo statusAlreadyViewed
- Optional statusPsa?: null | IStatusPSA
  
  WebMessageInfo statusPsa
- Optional urlNumber?: null | boolean
  
  WebMessageInfo urlNumber
- Optional urlText?: null | boolean
  
  WebMessageInfo urlText
- Optional userReceipt?: null | IUserReceipt[]
  
  WebMessageInfo userReceipt
- Optional verifiedBizName?: null | string
  
  WebMessageInfo verifiedBizName
- Defined in src/Classes/Ctx.ts:71

quoted

get quoted(): {
    audioMessage?: null | IAudioMessage;
    bcallMessage?: null | IBCallMessage;
    botInvokeMessage?: null | IFutureProofMessage;
    buttonsMessage?: null | IButtonsMessage;
    buttonsResponseMessage?: null | IButtonsResponseMessage;
    call?: null | ICall;
    callLogMesssage?: null | ICallLogMessage;
    cancelPaymentRequestMessage?: null | ICancelPaymentRequestMessage;
    chat?: null | IChat;
    commentMessage?: null | ICommentMessage;
    contactMessage?: null | IContactMessage;
    contactsArrayMessage?: null | IContactsArrayMessage;
    conversation?: null | string;
    declinePaymentRequestMessage?: null | IDeclinePaymentRequestMessage;
    decodedSenderJid: string;
    deviceSentMessage?: null | IDeviceSentMessage;
    documentMessage?: null | IDocumentMessage;
    documentWithCaptionMessage?: null | IFutureProofMessage;
    editedMessage?: null | IFutureProofMessage;
    encCommentMessage?: null | IEncCommentMessage;
    encEventUpdateMessage?: null | IEncEventUpdateMessage;
    encReactionMessage?: null | IEncReactionMessage;
    ephemeralMessage?: null | IFutureProofMessage;
    eventMessage?: null | IEventMessage;
    extendedTextMessage?: null | IExtendedTextMessage;
    extendedTextMessageWithParentKey?: null | IExtendedTextMessageWithParentKey;
    fastRatchetKeySenderKeyDistributionMessage?: null | ISenderKeyDistributionMessage;
    groupInviteMessage?: null | IGroupInviteMessage;
    groupMentionedMessage?: null | IFutureProofMessage;
    highlyStructuredMessage?: null | IHighlyStructuredMessage;
    imageMessage?: null | IImageMessage;
    interactiveMessage?: null | IInteractiveMessage;
    interactiveResponseMessage?: null | IInteractiveResponseMessage;
    invoiceMessage?: null | IInvoiceMessage;
    keepInChatMessage?: null | IKeepInChatMessage;
    listMessage?: null | IListMessage;
    listResponseMessage?: null | IListResponseMessage;
    liveLocationMessage?: null | ILiveLocationMessage;
    locationMessage?: null | ILocationMessage;
    lottieStickerMessage?: null | IFutureProofMessage;
    media: {
        toBuffer: (() => Promise<null | Buffer>);
        toStream: (() => Promise<null | Transform>);
    };
    messageContextInfo?: null | IMessageContextInfo;
    messageHistoryBundle?: null | IMessageHistoryBundle;
    newsletterAdminInviteMessage?: null | INewsletterAdminInviteMessage;
    orderMessage?: null | IOrderMessage;
    paymentInviteMessage?: null | IPaymentInviteMessage;
    pinInChatMessage?: null | IPinInChatMessage;
    placeholderMessage?: null | IPlaceholderMessage;
    pollCreationMessage?: null | IPollCreationMessage;
    pollCreationMessageV2?: null | IPollCreationMessage;
    pollCreationMessageV3?: null | IPollCreationMessage;
    pollUpdateMessage?: null | IPollUpdateMessage;
    productMessage?: null | IProductMessage;
    protocolMessage?: null | IProtocolMessage;
    ptvMessage?: null | IVideoMessage;
    reactionMessage?: null | IReactionMessage;
    requestPaymentMessage?: null | IRequestPaymentMessage;
    requestPhoneNumberMessage?: null | IRequestPhoneNumberMessage;
    scheduledCallCreationMessage?: null | IScheduledCallCreationMessage;
    scheduledCallEditMessage?: null | IScheduledCallEditMessage;
    sendPaymentMessage?: null | ISendPaymentMessage;
    senderJid: undefined | null | string;
    senderKeyDistributionMessage?: null | ISenderKeyDistributionMessage;
    stickerMessage?: null | IStickerMessage;
    stickerSyncRmrMessage?: null | IStickerSyncRMRMessage;
    templateButtonReplyMessage?: null | ITemplateButtonReplyMessage;
    templateMessage?: null | ITemplateMessage;
    videoMessage?: null | IVideoMessage;
    viewOnceMessage?: null | IFutureProofMessage;
    viewOnceMessageV2?: null | IFutureProofMessage;
    viewOnceMessageV2Extension?: null | IFutureProofMessage;
}
Returns {
    audioMessage?: null | IAudioMessage;
    bcallMessage?: null | IBCallMessage;
    botInvokeMessage?: null | IFutureProofMessage;
    buttonsMessage?: null | IButtonsMessage;
    buttonsResponseMessage?: null | IButtonsResponseMessage;
    call?: null | ICall;
    callLogMesssage?: null | ICallLogMessage;
    cancelPaymentRequestMessage?: null | ICancelPaymentRequestMessage;
    chat?: null | IChat;
    commentMessage?: null | ICommentMessage;
    contactMessage?: null | IContactMessage;
    contactsArrayMessage?: null | IContactsArrayMessage;
    conversation?: null | string;
    declinePaymentRequestMessage?: null | IDeclinePaymentRequestMessage;
    decodedSenderJid: string;
    deviceSentMessage?: null | IDeviceSentMessage;
    documentMessage?: null | IDocumentMessage;
    documentWithCaptionMessage?: null | IFutureProofMessage;
    editedMessage?: null | IFutureProofMessage;
    encCommentMessage?: null | IEncCommentMessage;
    encEventUpdateMessage?: null | IEncEventUpdateMessage;
    encReactionMessage?: null | IEncReactionMessage;
    ephemeralMessage?: null | IFutureProofMessage;
    eventMessage?: null | IEventMessage;
    extendedTextMessage?: null | IExtendedTextMessage;
    extendedTextMessageWithParentKey?: null | IExtendedTextMessageWithParentKey;
    fastRatchetKeySenderKeyDistributionMessage?: null | ISenderKeyDistributionMessage;
    groupInviteMessage?: null | IGroupInviteMessage;
    groupMentionedMessage?: null | IFutureProofMessage;
    highlyStructuredMessage?: null | IHighlyStructuredMessage;
    imageMessage?: null | IImageMessage;
    interactiveMessage?: null | IInteractiveMessage;
    interactiveResponseMessage?: null | IInteractiveResponseMessage;
    invoiceMessage?: null | IInvoiceMessage;
    keepInChatMessage?: null | IKeepInChatMessage;
    listMessage?: null | IListMessage;
    listResponseMessage?: null | IListResponseMessage;
    liveLocationMessage?: null | ILiveLocationMessage;
    locationMessage?: null | ILocationMessage;
    lottieStickerMessage?: null | IFutureProofMessage;
    media: {
        toBuffer: (() => Promise<null | Buffer>);
        toStream: (() => Promise<null | Transform>);
    };
    messageContextInfo?: null | IMessageContextInfo;
    messageHistoryBundle?: null | IMessageHistoryBundle;
    newsletterAdminInviteMessage?: null | INewsletterAdminInviteMessage;
    orderMessage?: null | IOrderMessage;
    paymentInviteMessage?: null | IPaymentInviteMessage;
    pinInChatMessage?: null | IPinInChatMessage;
    placeholderMessage?: null | IPlaceholderMessage;
    pollCreationMessage?: null | IPollCreationMessage;
    pollCreationMessageV2?: null | IPollCreationMessage;
    pollCreationMessageV3?: null | IPollCreationMessage;
    pollUpdateMessage?: null | IPollUpdateMessage;
    productMessage?: null | IProductMessage;
    protocolMessage?: null | IProtocolMessage;
    ptvMessage?: null | IVideoMessage;
    reactionMessage?: null | IReactionMessage;
    requestPaymentMessage?: null | IRequestPaymentMessage;
    requestPhoneNumberMessage?: null | IRequestPhoneNumberMessage;
    scheduledCallCreationMessage?: null | IScheduledCallCreationMessage;
    scheduledCallEditMessage?: null | IScheduledCallEditMessage;
    sendPaymentMessage?: null | ISendPaymentMessage;
    senderJid: undefined | null | string;
    senderKeyDistributionMessage?: null | ISenderKeyDistributionMessage;
    stickerMessage?: null | IStickerMessage;
    stickerSyncRmrMessage?: null | IStickerSyncRMRMessage;
    templateButtonReplyMessage?: null | ITemplateButtonReplyMessage;
    templateMessage?: null | ITemplateMessage;
    videoMessage?: null | IVideoMessage;
    viewOnceMessage?: null | IFutureProofMessage;
    viewOnceMessageV2?: null | IFutureProofMessage;
    viewOnceMessageV2Extension?: null | IFutureProofMessage;
}
- Optional audioMessage?: null | IAudioMessage
  
  Message audioMessage
- Optional bcallMessage?: null | IBCallMessage
  
  Message bcallMessage
- Optional botInvokeMessage?: null | IFutureProofMessage
  
  Message botInvokeMessage
- Optional buttonsMessage?: null | IButtonsMessage
  
  Message buttonsMessage
- Optional buttonsResponseMessage?: null | IButtonsResponseMessage
  
  Message buttonsResponseMessage
- Optional call?: null | ICall
  
  Message call
- Optional callLogMesssage?: null | ICallLogMessage
  
  Message callLogMesssage
- Optional cancelPaymentRequestMessage?: null | ICancelPaymentRequestMessage
  
  Message cancelPaymentRequestMessage
- Optional chat?: null | IChat
  
  Message chat
- Optional commentMessage?: null | ICommentMessage
  
  Message commentMessage
- Optional contactMessage?: null | IContactMessage
  
  Message contactMessage
- Optional contactsArrayMessage?: null | IContactsArrayMessage
  
  Message contactsArrayMessage
- Optional conversation?: null | string
  
  Message conversation
- Optional declinePaymentRequestMessage?: null | IDeclinePaymentRequestMessage
  
  Message declinePaymentRequestMessage
- decodedSenderJid: string
- Optional deviceSentMessage?: null | IDeviceSentMessage
  
  Message deviceSentMessage
- Optional documentMessage?: null | IDocumentMessage
  
  Message documentMessage
- Optional documentWithCaptionMessage?: null | IFutureProofMessage
  
  Message documentWithCaptionMessage
- Optional editedMessage?: null | IFutureProofMessage
  
  Message editedMessage
- Optional encCommentMessage?: null | IEncCommentMessage
  
  Message encCommentMessage
- Optional encEventUpdateMessage?: null | IEncEventUpdateMessage
  
  Message encEventUpdateMessage
- Optional encReactionMessage?: null | IEncReactionMessage
  
  Message encReactionMessage
- Optional ephemeralMessage?: null | IFutureProofMessage
  
  Message ephemeralMessage
- Optional eventMessage?: null | IEventMessage
  
  Message eventMessage
- Optional extendedTextMessage?: null | IExtendedTextMessage
  
  Message extendedTextMessage
- Optional extendedTextMessageWithParentKey?: null | IExtendedTextMessageWithParentKey
  
  Message extendedTextMessageWithParentKey
- Optional fastRatchetKeySenderKeyDistributionMessage?: null | ISenderKeyDistributionMessage
  
  Message fastRatchetKeySenderKeyDistributionMessage
- Optional groupInviteMessage?: null | IGroupInviteMessage
  
  Message groupInviteMessage
- Optional groupMentionedMessage?: null | IFutureProofMessage
  
  Message groupMentionedMessage
- Optional highlyStructuredMessage?: null | IHighlyStructuredMessage
  
  Message highlyStructuredMessage
- Optional imageMessage?: null | IImageMessage
  
  Message imageMessage
- Optional interactiveMessage?: null | IInteractiveMessage
  
  Message interactiveMessage
- Optional interactiveResponseMessage?: null | IInteractiveResponseMessage
  
  Message interactiveResponseMessage
- Optional invoiceMessage?: null | IInvoiceMessage
  
  Message invoiceMessage
- Optional keepInChatMessage?: null | IKeepInChatMessage
  
  Message keepInChatMessage
- Optional listMessage?: null | IListMessage
  
  Message listMessage
- Optional listResponseMessage?: null | IListResponseMessage
  
  Message listResponseMessage
- Optional liveLocationMessage?: null | ILiveLocationMessage
  
  Message liveLocationMessage
- Optional locationMessage?: null | ILocationMessage
  
  Message locationMessage
- Optional lottieStickerMessage?: null | IFutureProofMessage
  
  Message lottieStickerMessage
- media: {
  toBuffer: (() => Promise<null | Buffer>);
  toStream: (() => Promise<null | Transform>);
  }
  - toBuffer: (() => Promise<null | Buffer>)
    - - (): Promise<null | Buffer>
      - Returns Promise<null | Buffer>
  - toStream: (() => Promise<null | Transform>)
    - - (): Promise<null | Transform>
      - Returns Promise<null | Transform>
- Optional messageContextInfo?: null | IMessageContextInfo
  
  Message messageContextInfo
- Optional messageHistoryBundle?: null | IMessageHistoryBundle
  
  Message messageHistoryBundle
- Optional newsletterAdminInviteMessage?: null | INewsletterAdminInviteMessage
  
  Message newsletterAdminInviteMessage
- Optional orderMessage?: null | IOrderMessage
  
  Message orderMessage
- Optional paymentInviteMessage?: null | IPaymentInviteMessage
  
  Message paymentInviteMessage
- Optional pinInChatMessage?: null | IPinInChatMessage
  
  Message pinInChatMessage
- Optional placeholderMessage?: null | IPlaceholderMessage
  
  Message placeholderMessage
- Optional pollCreationMessage?: null | IPollCreationMessage
  
  Message pollCreationMessage
- Optional pollCreationMessageV2?: null | IPollCreationMessage
  
  Message pollCreationMessageV2
- Optional pollCreationMessageV3?: null | IPollCreationMessage
  
  Message pollCreationMessageV3
- Optional pollUpdateMessage?: null | IPollUpdateMessage
  
  Message pollUpdateMessage
- Optional productMessage?: null | IProductMessage
  
  Message productMessage
- Optional protocolMessage?: null | IProtocolMessage
  
  Message protocolMessage
- Optional ptvMessage?: null | IVideoMessage
  
  Message ptvMessage
- Optional reactionMessage?: null | IReactionMessage
  
  Message reactionMessage
- Optional requestPaymentMessage?: null | IRequestPaymentMessage
  
  Message requestPaymentMessage
- Optional requestPhoneNumberMessage?: null | IRequestPhoneNumberMessage
  
  Message requestPhoneNumberMessage
- Optional scheduledCallCreationMessage?: null | IScheduledCallCreationMessage
  
  Message scheduledCallCreationMessage
- Optional scheduledCallEditMessage?: null | IScheduledCallEditMessage
  
  Message scheduledCallEditMessage
- Optional sendPaymentMessage?: null | ISendPaymentMessage
  
  Message sendPaymentMessage
- senderJid: undefined | null | string
- Optional senderKeyDistributionMessage?: null | ISenderKeyDistributionMessage
  
  Message senderKeyDistributionMessage
- Optional stickerMessage?: null | IStickerMessage
  
  Message stickerMessage
- Optional stickerSyncRmrMessage?: null | IStickerSyncRMRMessage
  
  Message stickerSyncRmrMessage
- Optional templateButtonReplyMessage?: null | ITemplateButtonReplyMessage
  
  Message templateButtonReplyMessage
- Optional templateMessage?: null | ITemplateMessage
  
  Message templateMessage
- Optional videoMessage?: null | IVideoMessage
  
  Message videoMessage
- Optional viewOnceMessage?: null | IFutureProofMessage
  
  Message viewOnceMessage
- Optional viewOnceMessageV2?: null | IFutureProofMessage
  
  Message viewOnceMessageV2
- Optional viewOnceMessageV2Extension?: null | IFutureProofMessage
  
  Message viewOnceMessageV2Extension
- Defined in src/Classes/Ctx.ts:239

sender

get sender(): {
    decodedJid: undefined | null | string;
    jid: undefined | null | string;
    pushName: undefined | null | string;
}
Returns {
    decodedJid: undefined | null | string;
    jid: undefined | null | string;
    pushName: undefined | null | string;
}
- decodedJid: undefined | null | string
- jid: undefined | null | string
- pushName: undefined | null | string
- Defined in src/Classes/Ctx.ts:81

used

get used(): {
    command?: string;
    hears?: any;
    poll?: any;
    pollVote?: any;
    prefix?: string | string[];
    reactions?: any;
    upsert?: any;
}
Returns {
    command?: string;
    hears?: any;
    poll?: any;
    pollVote?: any;
    prefix?: string | string[];
    reactions?: any;
    upsert?: any;
}
- Optional command?: string
- Optional hears?: any
- Optional poll?: any
- Optional pollVote?: any
- Optional prefix?: string | string[]
- Optional reactions?: any
- Optional upsert?: any
- Defined in src/Classes/Ctx.ts:43

Methods

MessageCollector

MessageCollector(args?): MessageCollector
Parameters
- args: ICollectorOptions = ...
Returns MessageCollector
- Defined in src/Classes/Ctx.ts:124

awaitMessages

awaitMessages(args?): Promise<unknown>
Parameters
- args: ICollectorOptions = ...
Returns Promise<unknown>
- Defined in src/Classes/Ctx.ts:135

block

block(jid?): Promise<void>
Parameters
- Optional jid: string
Returns Promise<void>
- Defined in src/Classes/Ctx.ts:215

decodeJid

decodeJid(jid): string
Parameters
- jid: string
Returns string
- Defined in src/Classes/Ctx.ts:331

deleteMessage

deleteMessage(key): Promise<undefined | WebMessageInfo>
Parameters
- key: IMessageKey
Returns Promise<undefined | WebMessageInfo>
- Defined in src/Classes/Ctx.ts:183

downloadContentFromMessage

downloadContentFromMessage(downloadable, type, opts?): Promise<Transform>
Parameters
- downloadable: DownloadableMessage
- type: "audio" | "document" | "gif" | "image" | "ppic" | "product" | "ptt" | "sticker" | "video" | "thumbnail-document" | "thumbnail-image" | "thumbnail-video" | "thumbnail-link" | "md-msg-hist" | "md-app-state" | "product-catalog-image" | "payment-bg-image" | "ptv"
- Optional opts: MediaDownloadOptions
Returns Promise<Transform>
- Defined in src/Classes/Ctx.ts:279

editMessage

editMessage(key, newText): Promise<undefined | WebMessageInfo>
Parameters
- key: IMessageKey
- newText: string
Returns Promise<undefined | WebMessageInfo>
- Defined in src/Classes/Ctx.ts:191

getContentType

getContentType(content): undefined | keyof IMessage
Parameters
- content: undefined | IMessage
Returns undefined | keyof IMessage
- Defined in src/Classes/Ctx.ts:275

getDevice

getDevice(id): "android" | "unknown" | "web" | "ios" | "desktop"
Parameters
- id: undefined | string
Returns "android" | "unknown" | "web" | "ios" | "desktop"
- Defined in src/Classes/Ctx.ts:207

getMediaMessage

getMediaMessage(msg, type): Promise<null | Buffer | Transform>
Parameters
- msg: IMessageInfo
- type: "buffer" | "stream"
Returns Promise<null | Buffer | Transform>
- Defined in src/Classes/Ctx.ts:159

getMentioned

getMentioned(): undefined | null | string[]
Returns undefined | null | string[]
- Defined in src/Classes/Ctx.ts:203

getMessageType

getMessageType(): undefined | keyof IMessage
Returns undefined | keyof IMessage
- Defined in src/Classes/Ctx.ts:155

group

group(jid?): GroupData
Parameters
- Optional jid: string
Returns GroupData
- Defined in src/Classes/Ctx.ts:235

isGroup

isGroup(): undefined | boolean
Returns undefined | boolean
- Defined in src/Classes/Ctx.ts:211

prepareWAMessageMedia

prepareWAMessageMedia(message, options): Promise<Message>
Parameters
- message: AnyMediaMessageContent
- options: MediaGenerationOptions
Returns Promise<Message>
- Defined in src/Classes/Ctx.ts:327

react

react(jid, emoji, key?): Promise<undefined | WebMessageInfo>
Parameters
- jid: string
- emoji: string
- Optional key: IMessageKey
Returns Promise<undefined | WebMessageInfo>
- Defined in src/Classes/Ctx.ts:118

read

read(): void
Returns void
- Defined in src/Classes/Ctx.ts:168

reply

reply(content, options?): Promise<undefined | WebMessageInfo>
Parameters
- content: string | AnyMessageContent
- options: MiscMessageGenerationOptions = {}
Returns Promise<undefined | WebMessageInfo>
- Defined in src/Classes/Ctx.ts:106

replyInteractiveMessage

replyInteractiveMessage(content, options?): Promise<void>
Parameters
- content: IInteractiveMessageContent
- options: {} | MessageGenerationOptionsFromContent = {}
Returns Promise<void>
- Defined in src/Classes/Ctx.ts:320

replyWithJid

replyWithJid(jid, content, options?): Promise<undefined | WebMessageInfo>
Parameters
- jid: string
- content: AnyMessageContent
- options: MiscMessageGenerationOptions = {}
Returns Promise<undefined | WebMessageInfo>
- Defined in src/Classes/Ctx.ts:114

sendInteractiveMessage

sendInteractiveMessage(jid, content, options?): void
Parameters
- jid: string
- content: IInteractiveMessageContent
- options: {} | MessageGenerationOptionsFromContent = {}
Returns void
- Defined in src/Classes/Ctx.ts:283

sendMessage

sendMessage(jid, content, options?): Promise<undefined | WebMessageInfo>
Parameters
- jid: string
- content: AnyMessageContent
- options: MiscMessageGenerationOptions = {}
Returns Promise<undefined | WebMessageInfo>
- Defined in src/Classes/Ctx.ts:85

sendPoll

sendPoll(jid, args): Promise<undefined | WebMessageInfo>
Parameters
- jid: string
- args: {
      name: string;
      selectableCount?: boolean;
      singleSelect: boolean;
      values: string[];
  }
  - name: string
  - Optional selectableCount?: boolean
  - singleSelect: boolean
  - values: string[]
Returns Promise<undefined | WebMessageInfo>
- Defined in src/Classes/Ctx.ts:198

simulateRecording

simulateRecording(): void
Returns void
- Defined in src/Classes/Ctx.ts:187

simulateTyping

simulateTyping(): void
Returns void
- Defined in src/Classes/Ctx.ts:179

unblock

unblock(jid?): Promise<void>
Parameters
- Optional jid: string
Returns Promise<void>
- Defined in src/Classes/Ctx.ts:223

Class Ctx

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: ICtxOptions

Returns Ctx

Properties

_args

_client

Type declaration

addChatLabel: ((jid, labelId) => Promise<void>)

Parameters

jid: string

labelId: string

Returns Promise<void>

addLabel: ((jid, labels) => Promise<void>)

Parameters

jid: string

labels: LabelActionBody

Returns Promise<void>

addMessageLabel: ((jid, messageId, labelId) => Promise<void>)

Parameters

jid: string

messageId: string

labelId: string

Returns Promise<void>

appPatch: ((patchCreate) => Promise<void>)

Parameters

patchCreate: WAPatchCreate

Returns Promise<void>

assertSessions: ((jids, force) => Promise<boolean>)

Parameters

jids: string[]

force: boolean

Returns Promise<boolean>

authState: { creds: AuthenticationCreds; keys: SignalKeyStoreWithTransaction; }

creds: AuthenticationCreds

keys: SignalKeyStoreWithTransaction

chatModify: ((mod, jid) => Promise<void>)

Parameters

mod: ChatModification

jid: string

Returns Promise<void>

cleanDirtyBits: ((type, fromTimestamp?) => Promise<void>)

Parameters

type: "account_sync" | "groups"

Optional fromTimestamp: string | number

Returns Promise<void>

createParticipantNodes: ((jids, message, extraAttrs?) => Promise<{ nodes: BinaryNode[]; shouldIncludeDeviceIdentity: boolean; }>)

Parameters

jids: string[]

message: IMessage

Optional extraAttrs: { [key: string]: string; }

[key: string]: string

Returns Promise<{ nodes: BinaryNode[]; shouldIncludeDeviceIdentity: boolean; }>

end: ((error) => void)

Parameters

error: undefined | Error

Returns void

ev: BaileysEventEmitter & { buffer() => void; createBufferedFunction<A, T_1>(work) => ((...args) => Promise<T_1>); flush(force?) => boolean; isBuffering() => boolean; process(handler) => (() => void); }

executeUSyncQuery: ((usyncQuery) => Promise<undefined | USyncQueryResult>)

Parameters

usyncQuery: USyncQuery

Returns Promise<undefined | USyncQueryResult>

fetchBlocklist: (() => Promise<string[]>)

Returns Promise<string[]>

fetchDisappearingDuration: ((...jids) => Promise<undefined | USyncQueryResultList[]>)

Parameters

Rest ...jids: string[]

Returns Promise<undefined | USyncQueryResultList[]>

fetchMessageHistory: ((count, oldestMsgKey, oldestMsgTimestamp) => Promise<string>)

Parameters

count: number

authState: {
creds: AuthenticationCreds;
keys: SignalKeyStoreWithTransaction;
}

`Optional` fromTimestamp: string | number

createParticipantNodes: ((jids, message, extraAttrs?) => Promise<{
nodes: BinaryNode[];
shouldIncludeDeviceIdentity: boolean;
}>)

`Optional` extraAttrs: {
[key: string]: string;
}

Returns Promise<{
nodes: BinaryNode[];
shouldIncludeDeviceIdentity: boolean;
}>

ev: BaileysEventEmitter & {
buffer() => void;
createBufferedFunction<A, T_1>(work) => ((...args) => Promise<T_1>);
flush(force?) => boolean;
isBuffering() => boolean;
process(handler) => (() => void);
}

`Rest` ...jids: string[]

fetchPrivacySettings: ((force?) => Promise<{
[_: string]: string;
}>)

`Optional` force: boolean

Returns Promise<{
[_: string]: string;
}>

`Rest` ...jids: string[]

getCatalog: ((__namedParameters) => Promise<{
nextPageCursor: undefined | string;
products: Product[];
}>)

Returns Promise<{
nextPageCursor: undefined | string;
products: Product[];
}>

getCollections: ((jid?, limit?) => Promise<{
collections: CatalogCollection[];
}>)

`Optional` jid: string

`Optional` limit: number

Returns Promise<{
collections: CatalogCollection[];
}>

groupFetchAllParticipating: (() => Promise<{
[_: string]: GroupMetadata;
}>)

Returns Promise<{
[_: string]: GroupMetadata;
}>