Class StoryAttachment

Hierarchy (view full)

Attachment<IStoryAttachmentPayload, STORY | "story">
- StoryAttachment

Constructors

constructor

new StoryAttachment(options): StoryAttachment
Constructor
Parameters
- options: StoryAttachmentOptions
Returns StoryAttachment
Overrides Attachment.constructor
- Defined in packages/vk-io/src/structures/attachments/story.ts:81

Properties

`Protected` $filled

$filled: boolean

`Protected` [kParentStory]

[kParentStory]: undefined | StoryAttachment

`Protected` [kPhoto]

[kPhoto]: undefined | PhotoAttachment

`Protected` [kVideo]

[kVideo]: undefined | VideoAttachment

`Protected` api

api: API

`Protected` payload

payload: ISharedAttachmentPayload & IStoryAttachmentPayload

type

type: "story" | STORY

Accessors

[toStringTag]

get [toStringTag](): string
Returns custom tag

Returns string
Inherited from Attachment.[toStringTag]
- Defined in packages/vk-io/src/structures/attachments/attachment.ts:65

accessKey

get accessKey(): undefined | string
Returns undefined | string
Inherited from Attachment.accessKey
- Defined in packages/vk-io/src/structures/attachments/attachment.ts:58

canBeAttached

get canBeAttached(): boolean
Can be attached via string representation

Returns boolean
Inherited from Attachment.canBeAttached
- Defined in packages/vk-io/src/structures/attachments/attachment.ts:101

clickableStickers

get clickableStickers(): undefined | {
    clickable_stickers: {
        clickable_area: {
            x: number;
            y: number;
        }[];
        type: "mention" | "hashtag";
    }[];
    hashtag?: string;
    mention?: string;
    original_height: number;
    original_width: number;
    style: string;
}
Returns the parent story clickable stickers

Returns undefined | {
    clickable_stickers: {
        clickable_area: {
            x: number;
            y: number;
        }[];
        type: "mention" | "hashtag";
    }[];
    hashtag?: string;
    mention?: string;
    original_height: number;
    original_width: number;
    style: string;
}
- Defined in packages/vk-io/src/structures/attachments/story.ts:249

createdAt

get createdAt(): undefined | number
Returns the date when this story was created

Returns undefined | number
- Defined in packages/vk-io/src/structures/attachments/story.ts:193

expiresAt

get expiresAt(): undefined | number
Returns the date when this story was expires

Returns undefined | number
- Defined in packages/vk-io/src/structures/attachments/story.ts:200

id

get id(): number
Returns number
Inherited from Attachment.id
- Defined in packages/vk-io/src/structures/attachments/attachment.ts:50

isCanComment

get isCanComment(): undefined | boolean
Checks can story comment

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/story.ts:161

isCanReply

get isCanReply(): undefined | boolean
Checks can story reply

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/story.ts:139

isCanShare

get isCanShare(): undefined | boolean
Checks can story share

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/story.ts:150

isDeleted

get isDeleted(): undefined | boolean
Checks is story deleted

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/story.ts:121

isExpired

get isExpired(): undefined | boolean
Checks is story expired

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/story.ts:114

isFilled

get isFilled(): boolean
Returns whether the attachment is filled

Returns boolean
Inherited from Attachment.isFilled
- Defined in packages/vk-io/src/structures/attachments/attachment.ts:93

isSeen

get isSeen(): undefined | boolean
Checks is story viewed by current user

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/story.ts:128

link

get link(): undefined | {
text: string;
url: string;
}
Returns the story link

Returns undefined | {
text: string;
url: string;
}
- Defined in packages/vk-io/src/structures/attachments/story.ts:214

ownerId

get ownerId(): number
Returns number
Inherited from Attachment.ownerId
- Defined in packages/vk-io/src/structures/attachments/attachment.ts:54

parentStory

get parentStory(): undefined | StoryAttachment
Returns the parent story

Returns undefined | StoryAttachment
- Defined in packages/vk-io/src/structures/attachments/story.ts:242

parentStoryId

get parentStoryId(): undefined | number
Returns the parent story id

Returns undefined | number
- Defined in packages/vk-io/src/structures/attachments/story.ts:228

parentStoryOwnerId

get parentStoryOwnerId(): undefined | number
Returns the parent story owner id

Returns undefined | number
- Defined in packages/vk-io/src/structures/attachments/story.ts:235

photo

get photo(): undefined | PhotoAttachment
Returns the story photo

Returns undefined | PhotoAttachment
- Defined in packages/vk-io/src/structures/attachments/story.ts:179

replies

get replies(): undefined | {
count: number;
new: number;
}
Returns the story replies

Returns undefined | {
count: number;
new: number;
}
- Defined in packages/vk-io/src/structures/attachments/story.ts:221

storyType

get storyType(): undefined | "video" | "photo"
Returns the type of story

Returns undefined | "video" | "photo"
- Defined in packages/vk-io/src/structures/attachments/story.ts:172

video

get video(): undefined | VideoAttachment
Returns the story video

Returns undefined | VideoAttachment
- Defined in packages/vk-io/src/structures/attachments/story.ts:186

viewsCount

get viewsCount(): undefined | number
Returns the story views count

Returns undefined | number
- Defined in packages/vk-io/src/structures/attachments/story.ts:207

Methods

[kSerializeData]

[kSerializeData](): object
Returns the custom data

Returns object
Overrides Attachment.[kSerializeData]
- Defined in packages/vk-io/src/structures/attachments/story.ts:284

`Private` applyPayload

applyPayload(payload): void
Applies the payload
Parameters
- payload: IStoryAttachmentPayload
Returns void
- Defined in packages/vk-io/src/structures/attachments/story.ts:256

equals

equals(attachment): boolean
Checks that the attachment is equivalent with object
Parameters
- attachment: string | Attachment<object, string>
Returns boolean
Inherited from Attachment.equals
- Defined in packages/vk-io/src/structures/attachments/attachment.ts:108

loadAttachmentPayload

loadAttachmentPayload(): Promise<void>
Load attachment payload

Returns Promise<void>
- Defined in packages/vk-io/src/structures/attachments/story.ts:96

toJSON

toJSON(): object
Returns data for JSON

Returns object
Inherited from Attachment.toJSON
- Defined in packages/vk-io/src/structures/attachments/attachment.ts:134

toString

toString(): string
Returns a string to attach a VK

Returns string
Inherited from Attachment.toString
- Defined in packages/vk-io/src/structures/attachments/attachment.ts:123

`Static` fromString

fromString(attachment, api): Attachment<object, string>
Parse attachment with string
Parameters
- attachment: string
- api: API
Returns Attachment<object, string>
Inherited from Attachment.fromString
- Defined in packages/vk-io/src/structures/attachments/attachment.ts:72

Class StoryAttachment

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: StoryAttachmentOptions

Returns StoryAttachment

Properties

Protected $filled

Protected [kParentStory]

Protected [kPhoto]

Protected [kVideo]

Protected api

Protected payload

type

Accessors

[toStringTag]

Returns string

accessKey

Returns undefined | string

canBeAttached

Returns boolean

clickableStickers

Returns undefined | { clickable_stickers: { clickable_area: { x: number; y: number; }[]; type: "mention" | "hashtag"; }[]; hashtag?: string; mention?: string; original_height: number; original_width: number; style: string; }

createdAt

Returns undefined | number

expiresAt

Returns undefined | number

id

Returns number

isCanComment

Returns undefined | boolean

isCanReply

Returns undefined | boolean

isCanShare

Returns undefined | boolean

isDeleted

Returns undefined | boolean

isExpired

Returns undefined | boolean

isFilled

Returns boolean

isSeen

Returns undefined | boolean

link

Returns undefined | { text: string; url: string; }

ownerId

Returns number

parentStory

Returns undefined | StoryAttachment

parentStoryId

Returns undefined | number

parentStoryOwnerId

Returns undefined | number

photo

Returns undefined | PhotoAttachment

replies

Returns undefined | { count: number; new: number; }

storyType

Returns undefined | "video" | "photo"

video

Returns undefined | VideoAttachment

viewsCount

Returns undefined | number

Methods

[kSerializeData]

Returns object

Private applyPayload

Parameters

payload: IStoryAttachmentPayload

Returns void

equals

Parameters

attachment: string | Attachment<object, string>

Returns boolean

`Protected` $filled

`Protected` [kParentStory]

`Protected` [kPhoto]

`Protected` [kVideo]

`Protected` api

`Protected` payload

Returns undefined | {
clickable_stickers: {
clickable_area: {
x: number;
y: number;
}[];
type: "mention" | "hashtag";
}[];
hashtag?: string;
mention?: string;
original_height: number;
original_width: number;
style: string;
}

Returns undefined | {
text: string;
url: string;
}

Returns undefined | {
count: number;
new: number;
}

`Private` applyPayload

`Static` fromString