Class FriendActivityContext<S>

Type Parameters

S = ContextDefaultState

Hierarchy (view full)

Context<IFriendActivityContextPayload, S, FriendActivityContextType, FriendActivityContextSubType>
- FriendActivityContext

Index

Constructors

Properties

$groupId? api payload state subTypes type upload

Accessors

[toStringTag] applicationId eventAt isInvisible isOffline isOnline isSelfLeave isTimeoutLeave platform userId

Methods

[kSerializeData] is toJSON

Constructors

constructor

new FriendActivityContext<S>(options): FriendActivityContext<S>
Type Parameters
- S = ContextDefaultState
Parameters
- options: FriendActivityContextOptions<S>
Returns FriendActivityContext<S>
Overrides Context.constructor
- Defined in packages/vk-io/src/structures/contexts/friend-activity.ts:36

Properties

`Optional` $groupId

$groupId?: number

`Protected` api

api: API

`Protected` payload

payload: IFriendActivityContextPayload

state

state: S

subTypes

subTypes: FriendActivityContextSubType[]

type

type: "friend_activity"

`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

applicationId

get applicationId(): number
Returns the identifier of the application from which the friend was online

Returns number
- Defined in packages/vk-io/src/structures/contexts/friend-activity.ts:103

eventAt

get eventAt(): number
Returns the date when this event was created

Returns number
- Defined in packages/vk-io/src/structures/contexts/friend-activity.ts:110

isInvisible

get isInvisible(): boolean
Checks that the user is invisible

Returns boolean
- Defined in packages/vk-io/src/structures/contexts/friend-activity.ts:73

isOffline

get isOffline(): boolean
Checks that the user is online

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

isOnline

get isOnline(): boolean
Checks that the user is online

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

isSelfLeave

get isSelfLeave(): boolean
Checks that the user has logged out of the network himself

Returns boolean
- Defined in packages/vk-io/src/structures/contexts/friend-activity.ts:82

isTimeoutLeave

get isTimeoutLeave(): boolean
Checks that the user logged out a timeout

Returns boolean
- Defined in packages/vk-io/src/structures/contexts/friend-activity.ts:89

platform

get platform(): undefined | number
Returns the platform from which the user entered
- 1 - m.vk.com or other unknown application
- 2 - iPhone
- 3 - iPad
- 4 - Android
- 5 - Windows Phone
- 6 - Windows
- 7 - vk.com or other unknown application
Returns undefined | number
- Defined in packages/vk-io/src/structures/contexts/friend-activity.ts:125

userId

get userId(): undefined | number
Returns the friend id

Returns undefined | number
- Defined in packages/vk-io/src/structures/contexts/friend-activity.ts:96

Methods

[kSerializeData]

[kSerializeData](): object
Returns the custom data

Returns object
Overrides Context.[kSerializeData]
- Defined in packages/vk-io/src/structures/contexts/friend-activity.ts:136

is

is(rawTypes): boolean
Checks whether the context of some of these types
Parameters
- rawTypes: ("friend_activity" | FriendActivityContextSubType)[]
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

Generated using TypeDoc