Class GroupUserContext<S>

Type Parameters

S = ContextDefaultState

Hierarchy (view full)

Context<IGroupUserContextPayload, S, GroupUserContextType, GroupUserContextSubType>
- GroupUserContext

Index

Constructors

Properties

$groupId? api payload state subTypes type upload

Accessors

[toStringTag] adminId comment isBlocked isExpired isUnblocked reasonId reasonName unblockAt userId

Methods

[kSerializeData] ban is toJSON unban

Constructors

constructor

new GroupUserContext<S>(options): GroupUserContext<S>
Type Parameters
- S = ContextDefaultState
Parameters
- options: GroupUserContextOptions<S>
Returns GroupUserContext<S>
Overrides Context.constructor
- Defined in packages/vk-io/src/structures/contexts/group-user.ts:45

Properties

`Optional` $groupId

$groupId?: number

`Protected` api

api: API

`Protected` payload

payload: IGroupUserContextPayload

state

state: S

subTypes

subTypes: GroupUserContextSubType[]

type

type: "group_user"

`Protected` upload

upload: Upload

Accessors

[toStringTag]

get [toStringTag](): string
Returns custom tag

Returns string
Inherited from Context.[toStringTag]
- Defined in packages/vk-io/src/structures/contexts/context.ts:76

adminId

get adminId(): number
Returns the identifier admin

Returns number
- Defined in packages/vk-io/src/structures/contexts/group-user.ts:84

comment

get comment(): undefined | string
Returns the administrator comment to block

Returns undefined | string
- Defined in packages/vk-io/src/structures/contexts/group-user.ts:119

isBlocked

get isBlocked(): boolean
Checks is join user

Returns boolean
- Defined in packages/vk-io/src/structures/contexts/group-user.ts:59

isExpired

get isExpired(): undefined | boolean
Checks that the block has expired

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/contexts/group-user.ts:73

isUnblocked

get isUnblocked(): boolean
Checks is leave user

Returns boolean
- Defined in packages/vk-io/src/structures/contexts/group-user.ts:66

reasonId

get reasonId(): undefined | number
Returns the reason for the ban

Returns undefined | number
- Defined in packages/vk-io/src/structures/contexts/group-user.ts:98

reasonName

get reasonName(): undefined | string
Returns the reason name for the ban

Returns undefined | string
- Defined in packages/vk-io/src/structures/contexts/group-user.ts:105

unblockAt

get unblockAt(): undefined | number
Returns unblock date or undefined if permanent

Returns undefined | number
- Defined in packages/vk-io/src/structures/contexts/group-user.ts:112

userId

get userId(): number
Returns the identifier user

Returns number
- Defined in packages/vk-io/src/structures/contexts/group-user.ts:91

Methods

[kSerializeData]

[kSerializeData](): object
Returns the custom data

Returns object
Overrides Context.[kSerializeData]
- Defined in packages/vk-io/src/structures/contexts/group-user.ts:162

ban

ban(params): Promise<number>
Adds a user to the community blacklist
Parameters
- params: Partial<GroupsBanParams>
Returns Promise<number>
- Defined in packages/vk-io/src/structures/contexts/group-user.ts:126

is

is(rawTypes): boolean
Checks whether the context of some of these types
Parameters
- rawTypes: ("group_user" | GroupUserContextSubType)[]
Returns boolean
Inherited from Context.is
- Defined in packages/vk-io/src/structures/contexts/context.ts:83

toJSON

toJSON(): object
Returns data for JSON

Returns object
Inherited from Context.toJSON
- Defined in packages/vk-io/src/structures/contexts/context.ts:100

unban

unban(): Promise<number>
Adds a user to the community blacklist

Returns Promise<number>
- Defined in packages/vk-io/src/structures/contexts/group-user.ts:145

Generated using TypeDoc