Class ChatMemberAdministratorContext

Hierarchy

ChatMemberMemberContext
- ChatMemberAdministratorContext

Index

Constructors

constructor

new ChatMemberAdministratorContext(client, _source): ChatMemberAdministratorContext
Parameters
- client: Evogram
- _source: IChatMemberAdministrator & {
  chat_id: string | number;
  }
Returns ChatMemberAdministratorContext
Overrides ChatMemberMemberContext.constructor
- Defined in src/contexts/Chat/ChatMember/ChatMemberAdministratorContext.ts:6

Properties

`Protected` _client

_client: Evogram

`Protected` _source

_source: IChatMemberAdministrator & {
chat_id: string | number;
}

Accessors

customTitle

get customTitle(): undefined | string
- Returns the custom title of the administrator.
Returns undefined | string
- Defined in src/contexts/Chat/ChatMember/ChatMemberAdministratorContext.ts:36

isAnonymous

get isAnonymous(): boolean
Returns a boolean indicating whether the administrator is anonymous.

Returns boolean
true if the administator is anonymous, false otherwise.
- Defined in src/contexts/Chat/ChatMember/ChatMemberAdministratorContext.ts:33

permissions

get permissions(): {
    can_be_edited: boolean;
    can_change_info: boolean;
    can_delete_messages: boolean;
    can_edit_messages: undefined | boolean;
    can_invite_users: boolean;
    can_manage_chat: boolean;
    can_manage_topics: undefined | boolean;
    can_manage_video_chats: boolean;
    can_pin_messages: undefined | boolean;
    can_post_messages: undefined | boolean;
    can_promote_members: boolean;
    can_restrict_members: boolean;
}
Returns the chat member permissions.

Returns {
    can_be_edited: boolean;
    can_change_info: boolean;
    can_delete_messages: boolean;
    can_edit_messages: undefined | boolean;
    can_invite_users: boolean;
    can_manage_chat: boolean;
    can_manage_topics: undefined | boolean;
    can_manage_video_chats: boolean;
    can_pin_messages: undefined | boolean;
    can_post_messages: undefined | boolean;
    can_promote_members: boolean;
    can_restrict_members: boolean;
}
An object containing the member permissions.
- can_be_edited: boolean
- can_change_info: boolean
- can_delete_messages: boolean
- can_edit_messages: undefined | boolean
- can_invite_users: boolean
- can_manage_chat: boolean
- can_manage_topics: undefined | boolean
- can_manage_video_chats: boolean
- can_pin_messages: undefined | boolean
- can_post_messages: undefined | boolean
- can_promote_members: boolean
- can_restrict_members: boolean
- Defined in src/contexts/Chat/ChatMember/ChatMemberAdministratorContext.ts:12

Methods

ban

ban(params?): Promise<true>
Ban the chat member.
Parameters
- Optional params: Partial<IBanChatMemberParams>
  
  The ban parameters.
Returns Promise<true>
A promise that resolves to true if the ban was successful.
Inherited from ChatMemberMemberContext.ban
- Defined in src/contexts/Chat/ChatMember/ChatMemberMemberContext.ts:10

banSenderChat

banSenderChat(): Promise<true>
Ban the sender chat of the chat member.

Returns Promise<true>
A promise that resolves to true if the ban was successful.
Inherited from ChatMemberMemberContext.banSenderChat
- Defined in src/contexts/Chat/ChatMember/ChatMemberMemberContext.ts:18

demote

demote(): Promise<true>
Demotes the current chat administrator to a member.

Returns Promise<true>
A Promise that resolves to true on success.
- Defined in src/contexts/Chat/ChatMember/ChatMemberAdministratorContext.ts:42

promote

promote(params?): Promise<true>
Promote the chat member.
Parameters
- Optional params: Partial<IPromoteChatMemberParams>
  
  The promote parameters.
Returns Promise<true>
A promise that resolves to true if the promotion was successful.
Inherited from ChatMemberMemberContext.promote
- Defined in src/contexts/Chat/ChatMember/ChatMemberMemberContext.ts:55

restrict

restrict(permissions, params): Promise<true>
Restrict the chat member with the given permissions and parameters.
Parameters
- permissions: IChatPermissions
  
  The chat member's new permissions.
- params: Partial<IRestrictChatMemberParams>
  
  The restrict parameters.
Returns Promise<true>
A promise that resolves to true if the restrict was successful.
Inherited from ChatMemberMemberContext.restrict
- Defined in src/contexts/Chat/ChatMember/ChatMemberMemberContext.ts:28
restrict(params): Promise<true>
Restrict the chat member with the given parameters.
Parameters
- params: {
  permissions: IChatPermissions;
  } & Partial<IRestrictChatMemberParams>
  
  The restrict parameters, including the new permissions.
Returns Promise<true>
A promise that resolves to true if the restrict was successful.
Inherited from ChatMemberMemberContext.restrict
- Defined in src/contexts/Chat/ChatMember/ChatMemberMemberContext.ts:35

setCustomTitle

setCustomTitle(customTitle): Promise<true>
Sets a custom title for the current chat administrator.
Parameters
- customTitle: string
  
  The custom title to set.
Returns Promise<true>
A Promise that resolves to true on success.
- Defined in src/contexts/Chat/ChatMember/ChatMemberAdministratorContext.ts:64

toContext

toContext<TContext>(): TContext
Converts the source object to a context object of a given type.

Example
```
client.updates.on("message", message => {
        const user = message.user.toContext<CustomUserContext>();
        // Now user works correctly with your context
    })
```
Type Parameters
- TContext extends object
  
  Generic type parameter for the context object.
Returns TContext
The context object.
Inherited from ChatMemberMemberContext.toContext
- Defined in src/modules/context/Context.ts:16

Class ChatMemberAdministratorContext

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Evogram

_source: IChatMemberAdministrator & { chat_id: string | number; }

Returns ChatMemberAdministratorContext

Properties

Protected _client

Protected _source

Accessors

customTitle

Returns undefined | string

isAnonymous

Returns boolean

permissions

can_be_edited: boolean

can_change_info: boolean

can_delete_messages: boolean

can_edit_messages: undefined | boolean

can_invite_users: boolean

can_manage_chat: boolean

can_manage_topics: undefined | boolean

can_manage_video_chats: boolean

can_pin_messages: undefined | boolean

can_post_messages: undefined | boolean

can_promote_members: boolean

can_restrict_members: boolean

Methods

ban

Parameters

Optional params: Partial<IBanChatMemberParams>

Returns Promise<true>

banSenderChat

Returns Promise<true>

demote

Returns Promise<true>

promote

Parameters

Optional params: Partial<IPromoteChatMemberParams>

Returns Promise<true>

restrict

Parameters

permissions: IChatPermissions

params: Partial<IRestrictChatMemberParams>

Returns Promise<true>

Parameters

params: { permissions: IChatPermissions; } & Partial<IRestrictChatMemberParams>

Returns Promise<true>

setCustomTitle

Parameters

customTitle: string

Returns Promise<true>

toContext

Example

Type Parameters

TContext extends object

Returns TContext

Settings

Member Visibility

Theme

On This Page

_source: IChatMemberAdministrator & {
chat_id: string | number;
}

`Protected` _client

`Protected` _source

`Optional` params: Partial<IBanChatMemberParams>

`Optional` params: Partial<IPromoteChatMemberParams>

params: {
permissions: IChatPermissions;
} & Partial<IRestrictChatMemberParams>