teidesu/mtcute
1
0
Fork 0
Code Issues 15 Pull requests 1 Projects Releases Packages Wiki Activity Actions

docs(client): updated docs for createStickerSet

Browse source
This commit is contained in:
teidesu 2021-07-02 19:52:14 +03:00
parent 14d2f9ff08
commit 03cb8fd5e8
2 changed files with 18 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
packages/client/src/client.ts
View file

@ -2802,16 +2802,20 @@ export interface TelegramClient extends BaseTelegramClient {
}
): Promise<StickerSet>
/**
* Create a new sticker set (only for bots)
* Create a new sticker set.
*
* Only for bots.
* This is the only sticker-related method that
* users can use (they allowed it with the "import stickers" update)
*
* @param params
* @returns Newly created sticker set
*/
createStickerSet(params: {
/**
* Owner of the sticker set (must be user)
* Owner of the sticker set (must be user).
*
* If this pack is created from a user account,
* can only be `"self"`
*/
owner: InputPeerLike
@ -2824,8 +2828,8 @@ export interface TelegramClient extends BaseTelegramClient {
* Short name of the sticker set.
* Can only contain English letters, digits and underscores
* (i.e. must match `/^[a-zA-Z0-9_]+$/),
* and must end with `_by_<bot username>` (`<bot username>` is
* case-insensitive).
* and (for bots) must end with `_by_<bot username>`
* (`<bot username>` is case-insensitive).
*/
shortName: string

14
packages/client/src/methods/stickers/create-sticker-set.ts
View file

@ -17,9 +17,10 @@ const MASK_POS = {
} as const
/**
* Create a new sticker set (only for bots)
* Create a new sticker set.
*
* Only for bots.
* This is the only sticker-related method that
* users can use (they allowed it with the "import stickers" update)
*
* @param params
* @returns Newly created sticker set
@ -29,7 +30,10 @@ export async function createStickerSet(
this: TelegramClient,
params: {
/**
* Owner of the sticker set (must be user)
* Owner of the sticker set (must be user).
*
* If this pack is created from a user account,
* can only be `"self"`
*/
owner: InputPeerLike
@ -42,8 +46,8 @@ export async function createStickerSet(
* Short name of the sticker set.
* Can only contain English letters, digits and underscores
* (i.e. must match `/^[a-zA-Z0-9_]+$/),
* and must end with `_by_<bot username>` (`<bot username>` is
* case-insensitive).
* and (for bots) must end with `_by_<bot username>`
* (`<bot username>` is case-insensitive).
*/
shortName: string