@periskope/baileys
Version:
WhatsApp API
132 lines • 8.28 kB
TypeScript
import { proto } from '../../WAProto/index.js';
import type { GroupMetadata, ParticipantAction, SocketConfig, WAMessageKey } from '../Types/index.js';
import { type BinaryNode } from '../WABinary/index.js';
export declare const makeGroupsSocket: (config: SocketConfig) => {
groupMetadata: (jid: string) => Promise<GroupMetadata>;
groupCreate: (subject: string, participants: string[]) => Promise<GroupMetadata>;
groupLeave: (id: string) => Promise<void>;
groupUpdateSubject: (jid: string, subject: string) => Promise<void>;
groupRequestParticipantsList: (jid: string) => Promise<{
[key: string]: string;
}[]>;
groupRequestParticipantsUpdate: (jid: string, participants: string[], action: "approve" | "reject") => Promise<{
status: string;
jid: string | undefined;
}[]>;
groupParticipantsUpdate: (jid: string, participants: string[], action: ParticipantAction) => Promise<{
status: string;
jid: string | undefined;
content: BinaryNode;
}[]>;
groupUpdateDescription: (jid: string, description?: string) => Promise<void>;
groupInviteCode: (jid: string) => Promise<string | undefined>;
groupRevokeInvite: (jid: string) => Promise<string | undefined>;
groupAcceptInvite: (code: string) => Promise<string | undefined>;
/**
* revoke a v4 invite for someone
* @param groupJid group jid
* @param invitedJid jid of person you invited
* @returns true if successful
*/
groupRevokeInviteV4: (groupJid: string, invitedJid: string) => Promise<boolean>;
/**
* accept a GroupInviteMessage
* @param key the key of the invite message, or optionally only provide the jid of the person who sent the invite
* @param inviteMessage the message to accept
*/
groupAcceptInviteV4: (key: string | WAMessageKey, inviteMessage: proto.Message.IGroupInviteMessage) => Promise<any>;
groupGetInviteInfo: (code: string) => Promise<GroupMetadata>;
groupToggleEphemeral: (jid: string, ephemeralExpiration: number) => Promise<void>;
groupSettingUpdate: (jid: string, setting: "announcement" | "not_announcement" | "locked" | "unlocked") => Promise<void>;
groupMemberAddMode: (jid: string, mode: "admin_add" | "all_member_add") => Promise<void>;
groupJoinApprovalMode: (jid: string, mode: "on" | "off") => Promise<void>;
groupFetchAllParticipating: () => Promise<{
[_: string]: GroupMetadata;
}>;
getBotListV2: () => Promise<import("../Types/index.js").BotListInfo[]>;
processingMutex: {
mutex<T>(code: () => Promise<T> | T): Promise<T>;
};
fetchPrivacySettings: (force?: boolean) => Promise<{
[_: string]: string;
}>;
upsertMessage: (msg: import("../Types/index.js").WAMessage, type: import("../Types/index.js").MessageUpsertType) => Promise<void>;
appPatch: (patchCreate: import("../Types/index.js").WAPatchCreate) => Promise<void>;
sendPresenceUpdate: (type: import("../Types/index.js").WAPresence, toJid?: string) => Promise<void>;
presenceSubscribe: (toJid: string, tcToken?: Buffer) => Promise<void>;
profilePictureUrl: (jid: string, type?: "preview" | "image", timeoutMs?: number) => Promise<string | undefined>;
onWhatsApp: (...jids: string[]) => Promise<{
jid: string;
exists: unknown;
lid: unknown;
}[] | undefined>;
fetchBlocklist: () => Promise<(string | undefined)[]>;
fetchStatus: (...jids: string[]) => Promise<import("../index.js").USyncQueryResultList[] | undefined>;
fetchDisappearingDuration: (...jids: string[]) => Promise<import("../index.js").USyncQueryResultList[] | undefined>;
updateProfilePicture: (jid: string, content: import("../Types/index.js").WAMediaUpload, dimensions?: {
width: number;
height: number;
}) => Promise<void>;
removeProfilePicture: (jid: string) => Promise<void>;
updateProfileStatus: (status: string) => Promise<void>;
updateProfileName: (name: string) => Promise<void>;
updateBlockStatus: (jid: string, action: "block" | "unblock") => Promise<void>;
updateDisableLinkPreviewsPrivacy: (isPreviewsDisabled: boolean) => Promise<void>;
updateCallPrivacy: (value: import("../Types/index.js").WAPrivacyCallValue) => Promise<void>;
updateMessagesPrivacy: (value: import("../Types/index.js").WAPrivacyMessagesValue) => Promise<void>;
updateLastSeenPrivacy: (value: import("../Types/index.js").WAPrivacyValue) => Promise<void>;
updateOnlinePrivacy: (value: import("../Types/index.js").WAPrivacyOnlineValue) => Promise<void>;
updateProfilePicturePrivacy: (value: import("../Types/index.js").WAPrivacyValue) => Promise<void>;
updateStatusPrivacy: (value: import("../Types/index.js").WAPrivacyValue) => Promise<void>;
updateReadReceiptsPrivacy: (value: import("../Types/index.js").WAReadReceiptsValue) => Promise<void>;
updateGroupsAddPrivacy: (value: import("../Types/index.js").WAPrivacyGroupAddValue) => Promise<void>;
updateDefaultDisappearingMode: (duration: number) => Promise<void>;
getBusinessProfile: (jid: string) => Promise<import("../Types/index.js").WABusinessProfile | void>;
resyncAppState: (collections: readonly ("critical_unblock_low" | "regular_high" | "regular_low" | "critical_block" | "regular")[], isInitialSync: boolean) => Promise<void>;
chatModify: (mod: import("../Types/index.js").ChatModification, jid: string) => Promise<void>;
cleanDirtyBits: (type: "account_sync" | "groups", fromTimestamp?: number | string) => Promise<void>;
addOrEditContact: (jid: string, contact: proto.SyncActionValue.IContactAction) => Promise<void>;
removeContact: (jid: string) => Promise<void>;
addLabel: (jid: string, labels: import("../Types/Label.js").LabelActionBody) => Promise<void>;
addChatLabel: (jid: string, labelId: string) => Promise<void>;
removeChatLabel: (jid: string, labelId: string) => Promise<void>;
addMessageLabel: (jid: string, messageId: string, labelId: string) => Promise<void>;
removeMessageLabel: (jid: string, messageId: string, labelId: string) => Promise<void>;
star: (jid: string, messages: {
id: string;
fromMe?: boolean;
}[], star: boolean) => Promise<void>;
executeUSyncQuery: (usyncQuery: import("../index.js").USyncQuery) => Promise<import("../index.js").USyncQueryResult | undefined>;
type: "md";
ws: import("./Client/websocket.js").WebSocketClient;
ev: import("../Types/index.js").BaileysEventEmitter & {
process(handler: (events: Partial<import("../Types/index.js").BaileysEventMap>) => void | Promise<void>): () => void;
buffer(): void;
createBufferedFunction<A extends any[], T>(work: (...args: A) => Promise<T>): (...args: A) => Promise<T>;
flush(): boolean;
isBuffering(): boolean;
};
authState: {
creds: import("../Types/index.js").AuthenticationCreds;
keys: import("../Types/index.js").SignalKeyStoreWithTransaction;
};
signalRepository: import("../Types/index.js").SignalRepository;
user: import("../Types/index.js").Contact | undefined;
generateMessageTag: () => string;
query: (node: BinaryNode, timeoutMs?: number) => Promise<any>;
waitForMessage: <T>(msgId: string, timeoutMs?: number | undefined) => Promise<any>;
waitForSocketOpen: () => Promise<void>;
sendRawMessage: (data: Uint8Array | Buffer) => Promise<void>;
sendNode: (frame: BinaryNode) => Promise<void>;
logout: (msg?: string) => Promise<void>;
end: (error: Error | undefined) => void;
onUnexpectedError: (err: Error | import("@hapi/boom").Boom, msg: string) => void;
uploadPreKeys: (count?: number) => Promise<void>;
uploadPreKeysToServerIfRequired: () => Promise<void>;
requestPairingCode: (phoneNumber: string, customPairingCode?: string) => Promise<string>;
waitForConnectionUpdate: (check: (u: Partial<import("../Types/index.js").ConnectionState>) => Promise<boolean | undefined>, timeoutMs?: number) => Promise<void>;
sendWAMBuffer: (wamBuffer: Buffer) => Promise<any>;
};
export declare const extractGroupMetadata: (result: BinaryNode) => GroupMetadata;
export type GroupsSocket = ReturnType<typeof makeGroupsSocket>;
//# sourceMappingURL=groups.d.ts.map