Class Upload

Constructors

constructor

new Upload(__namedParameters): Upload
Constructor
Parameters
- __namedParameters: IUploadOptions
Returns Upload
- Defined in packages/vk-io/src/upload/upload.ts:67

Properties

`Private` api

api: API

`Protected` options

options: Required<Omit<IUploadOptions, "api">>

Accessors

[toStringTag]

get [toStringTag](): string
Returns custom tag

Returns string
- Defined in packages/vk-io/src/upload/upload.ts:82

Methods

audio

audio(params): Promise<AudioAttachment>
Uploads audio
Parameters
- params: IUploadParams & {
  artist?: string;
  title?: string;
  }
Returns Promise<AudioAttachment>
- Defined in packages/vk-io/src/upload/upload.ts:367

audioMessage

audioMessage(params): Promise<AudioMessageAttachment>
Uploads audio message
Parameters
- params: IUploadParams & {
      peer_id?: number;
      tags?: string;
      title?: string;
  }
Returns Promise<AudioMessageAttachment>
- Defined in packages/vk-io/src/upload/upload.ts:604

buildPayload

buildPayload(__namedParameters): Promise<{
formData: FormData;
knownLength: boolean;
}>
Building form data
Parameters
- __namedParameters: {
      attachmentType?: string;
      field: string;
      maxFiles: number;
      values: IUploadSourceMedia[];
  }
  - Optional attachmentType?: string
  - field: string
  - maxFiles: number
  - values: IUploadSourceMedia[]
Returns Promise<{
formData: FormData;
knownLength: boolean;
}>
- Defined in packages/vk-io/src/upload/upload.ts:940

chatPhoto

chatPhoto(params): Promise<{
chat: object;
message_id: number;
}>
Uploading the main photo for a chat
Parameters
- params: IUploadParams & {
      chat_id: number;
      crop_width?: number;
      crop_x?: number;
      crop_y?: number;
  }
Returns Promise<{
chat: object;
message_id: number;
}>
- Defined in packages/vk-io/src/upload/upload.ts:222

conduct

conduct(__namedParameters): Promise<any>
Behavior for the upload method
Parameters
- __namedParameters: IUploadConduct
Returns Promise<any>
- Defined in packages/vk-io/src/upload/upload.ts:853

conductDocument

conductDocument(params, __namedParameters?): Promise<any>
Uploads document
Parameters
- params: IUploadParams & {
  type?: string;
  }
- __namedParameters: {
  attachmentType: undefined | string;
  } = {}
  - attachmentType: undefined | string
Returns Promise<any>
- Defined in packages/vk-io/src/upload/upload.ts:469

conductMessageDocument

conductMessageDocument(params, __namedParameters?): Promise<any>
Uploads wall document
Parameters
- params: IUploadParams & {
  type?: string;
  }
- __namedParameters: {
  attachmentType: undefined | string;
  } = {}
  - attachmentType: undefined | string
Returns Promise<any>
- Defined in packages/vk-io/src/upload/upload.ts:556

conductWallDocument

conductWallDocument(params, __namedParameters?): Promise<any>
Uploads wall document
Parameters
- params: IUploadParams & {
  type?: string;
  }
- __namedParameters: {
  attachmentType: undefined | string;
  } = {}
  - attachmentType: undefined | string
Returns Promise<any>
- Defined in packages/vk-io/src/upload/upload.ts:512

document

document(params): Promise<DocumentAttachment>
Uploads document
Parameters
- params: IUploadParams & {
      group_id?: number;
      tags?: string;
      title?: string;
  }
Returns Promise<DocumentAttachment>
- Defined in packages/vk-io/src/upload/upload.ts:495

documentGraffiti

documentGraffiti(params): Promise<GraffitiAttachment>
Uploads graffiti in documents
Parameters
- params: IUploadParams & {
  group_id?: number;
  }
Returns Promise<GraffitiAttachment>
- Defined in packages/vk-io/src/upload/upload.ts:638

groupCover

groupCover(params): Promise<{
    images: {
        height: number;
        url: string;
        width: number;
    }[];
}>
Uploads community cover
Parameters
- params: IUploadParams & {
      crop_x?: number;
      crop_x2?: number;
      crop_y?: number;
      crop_y2?: number;
      group_id: number;
  }
Returns Promise<{
    images: {
        height: number;
        url: string;
        width: number;
    }[];
}>
- Defined in packages/vk-io/src/upload/upload.ts:676

marketAlbumPhoto

marketAlbumPhoto(params): Promise<PhotoAttachment>
Uploads a photo for the selection of goods
Parameters
- params: IUploadParams & {
  group_id: number;
  }
Returns Promise<PhotoAttachment>
- Defined in packages/vk-io/src/upload/upload.ts:339

marketPhoto

marketPhoto(params): Promise<PhotoAttachment>
Uploading a photo for a product
Parameters
- params: IUploadParams & {
      crop_width?: number;
      crop_x?: number;
      crop_y?: number;
      group_id: number;
      main_photo?: number;
  }
Returns Promise<PhotoAttachment>
- Defined in packages/vk-io/src/upload/upload.ts:305

messageDocument

messageDocument(params): Promise<DocumentAttachment>
Uploads message document
Parameters
- params: IUploadParams & {
      peer_id?: number;
      tags?: string;
      title?: string;
  }
Returns Promise<DocumentAttachment>
- Defined in packages/vk-io/src/upload/upload.ts:582

messageGraffiti

messageGraffiti(params): Promise<GraffitiAttachment>
Uploads graffiti in messages
Parameters
- params: IUploadParams & {
  peer_id?: number;
  }
Returns Promise<GraffitiAttachment>
- Defined in packages/vk-io/src/upload/upload.ts:657

messagePhoto

messagePhoto(params): Promise<PhotoAttachment>
Uploading a photo to a private message
Parameters
- params: IUploadParams & {
  peer_id?: number;
  }
Returns Promise<PhotoAttachment>
- Defined in packages/vk-io/src/upload/upload.ts:195

ownerPhoto

ownerPhoto(params): Promise<{
    photo_hash: string;
    photo_src: string;
    photo_src_big: string;
    photo_src_small: string;
    post_id: number;
    saved: number;
}>
Uploading the main photo of a user or community
Parameters
- params: IUploadParams & {
  owner_id?: number;
  }
Returns Promise<{
    photo_hash: string;
    photo_src: string;
    photo_src_big: string;
    photo_src_small: string;
    post_id: number;
    saved: number;
}>
- Defined in packages/vk-io/src/upload/upload.ts:157

photoAlbum

photoAlbum(params): Promise<PhotoAttachment[]>
Uploading photos to an album
Parameters
- params: IUploadParams & {
      album_id: number;
      caption?: string;
      group_id?: number;
      latitude?: number;
      longitude?: number;
  }
Returns Promise<PhotoAttachment[]>
- Defined in packages/vk-io/src/upload/upload.ts:89

pollPhoto

pollPhoto(params): Promise<Record<string, any>>
Uploads poll photo
Parameters
- params: IUploadParams & {
  owner_id?: number;
  }
Returns Promise<Record<string, any>>
- Defined in packages/vk-io/src/upload/upload.ts:830

storiesPhoto

storiesPhoto(params): Promise<StoryAttachment>
Uploads photo stories
Parameters
- params: IUploadParams & {
      add_to_news?: number;
      clickable_stickers?: string;
      group_id?: number;
      link_text: string;
      link_url: string;
      reply_to_story?: string;
      user_ids?: string | string[];
  }
Returns Promise<StoryAttachment>
- Defined in packages/vk-io/src/upload/upload.ts:739

storiesVideo

storiesVideo(params): Promise<StoryAttachment>
Uploads video stories
Parameters
- params: IUploadParams & {
      add_to_news?: number;
      clickable_stickers?: string;
      group_id?: number;
      link_text: string;
      link_url: string;
      reply_to_story?: string;
      user_ids?: string | string[];
  }
Returns Promise<StoryAttachment>
- Defined in packages/vk-io/src/upload/upload.ts:785

upload

upload(url, __namedParameters): Promise<any>
Upload form data
Parameters
- url: string | URL
- __namedParameters: {
      forceBuffer: boolean;
      formData: FormData;
      timeout: number;
  }
  - forceBuffer: boolean
  - formData: FormData
  - timeout: number
Returns Promise<any>
- Defined in packages/vk-io/src/upload/upload.ts:1036

video

video(params): Promise<VideoAttachment>
Uploads video
Parameters
- params: IUploadParams & {
      album_id?: number;
      compression?: number;
      description?: string;
      group_id?: number;
      is_private?: number;
      link?: string;
      name?: string;
      no_comments?: number;
      privacy_comment?: string;
      privacy_view?: string;
      repeat?: number;
      wallpost?: number;
  }
Returns Promise<VideoAttachment>
- Defined in packages/vk-io/src/upload/upload.ts:397

wallDocument

wallDocument(params): Promise<DocumentAttachment>
Uploads wall document
Parameters
- params: IUploadParams & {
      group_id?: number;
      tags?: string;
      title?: string;
  }
Returns Promise<DocumentAttachment>
- Defined in packages/vk-io/src/upload/upload.ts:538

wallPhoto

wallPhoto(params): Promise<PhotoAttachment>
Uploading photos to the wall
Parameters
- params: IUploadParams & {
      caption?: string;
      group_id?: number;
      latitude?: number;
      longitude?: number;
      user_id?: number;
  }
Returns Promise<PhotoAttachment>
- Defined in packages/vk-io/src/upload/upload.ts:124

Class Upload

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: IUploadOptions

Returns Upload

Properties

Private api

Protected options

Accessors

[toStringTag]

Returns string

Methods

audio

Parameters

params: IUploadParams & { artist?: string; title?: string; }

Returns Promise<AudioAttachment>

audioMessage

Parameters

params: IUploadParams & { peer_id?: number; tags?: string; title?: string; }

Returns Promise<AudioMessageAttachment>

buildPayload

Parameters

__namedParameters: { attachmentType?: string; field: string; maxFiles: number; values: IUploadSourceMedia[]; }

Optional attachmentType?: string

field: string

maxFiles: number

values: IUploadSourceMedia[]

Returns Promise<{ formData: FormData; knownLength: boolean; }>

chatPhoto

Parameters

params: IUploadParams & { chat_id: number; crop_width?: number; crop_x?: number; crop_y?: number; }

Returns Promise<{ chat: object; message_id: number; }>

conduct

Parameters

__namedParameters: IUploadConduct

Returns Promise<any>

conductDocument

Parameters

params: IUploadParams & { type?: string; }

__namedParameters: { attachmentType: undefined | string; } = {}

attachmentType: undefined | string

Returns Promise<any>

conductMessageDocument

Parameters

params: IUploadParams & { type?: string; }

__namedParameters: { attachmentType: undefined | string; } = {}

attachmentType: undefined | string

Returns Promise<any>

conductWallDocument

Parameters

params: IUploadParams & { type?: string; }

__namedParameters: { attachmentType: undefined | string; } = {}

attachmentType: undefined | string

Returns Promise<any>

document

Parameters

params: IUploadParams & { group_id?: number; tags?: string; title?: string; }

Returns Promise<DocumentAttachment>

documentGraffiti

Parameters

params: IUploadParams & { group_id?: number; }

Returns Promise<GraffitiAttachment>

groupCover

Parameters

params: IUploadParams & { crop_x?: number; crop_x2?: number; crop_y?: number; crop_y2?: number; group_id: number; }

Returns Promise<{ images: { height: number; url: string; width: number; }[]; }>

marketAlbumPhoto

Parameters

params: IUploadParams & { group_id: number; }

Returns Promise<PhotoAttachment>

marketPhoto

Parameters

params: IUploadParams & { crop_width?: number; crop_x?: number; crop_y?: number; group_id: number; main_photo?: number; }

Returns Promise<PhotoAttachment>

`Private` api

`Protected` options

params: IUploadParams & {
artist?: string;
title?: string;
}

params: IUploadParams & {
peer_id?: number;
tags?: string;
title?: string;
}

__namedParameters: {
attachmentType?: string;
field: string;
maxFiles: number;
values: IUploadSourceMedia[];
}

`Optional` attachmentType?: string

Returns Promise<{
formData: FormData;
knownLength: boolean;
}>

params: IUploadParams & {
chat_id: number;
crop_width?: number;
crop_x?: number;
crop_y?: number;
}

Returns Promise<{
chat: object;
message_id: number;
}>

params: IUploadParams & {
type?: string;
}

__namedParameters: {
attachmentType: undefined | string;
} = {}

params: IUploadParams & {
type?: string;
}

__namedParameters: {
attachmentType: undefined | string;
} = {}

params: IUploadParams & {
type?: string;
}

__namedParameters: {
attachmentType: undefined | string;
} = {}

params: IUploadParams & {
group_id?: number;
tags?: string;
title?: string;
}

params: IUploadParams & {
group_id?: number;
}

params: IUploadParams & {
crop_x?: number;
crop_x2?: number;
crop_y?: number;
crop_y2?: number;
group_id: number;
}

Returns Promise<{
images: {
height: number;
url: string;
width: number;
}[];
}>

params: IUploadParams & {
group_id: number;
}

params: IUploadParams & {
crop_width?: number;
crop_x?: number;
crop_y?: number;
group_id: number;
main_photo?: number;
}

params: IUploadParams & {
peer_id?: number;
tags?: string;
title?: string;
}

params: IUploadParams & {
peer_id?: number;
}

params: IUploadParams & {
peer_id?: number;
}

params: IUploadParams & {
owner_id?: number;
}

Returns Promise<{
photo_hash: string;
photo_src: string;
photo_src_big: string;
photo_src_small: string;
post_id: number;
saved: number;
}>

params: IUploadParams & {
album_id: number;
caption?: string;
group_id?: number;
latitude?: number;
longitude?: number;
}

params: IUploadParams & {
owner_id?: number;
}

params: IUploadParams & {
add_to_news?: number;
clickable_stickers?: string;
group_id?: number;
link_text: string;
link_url: string;
reply_to_story?: string;
user_ids?: string | string[];
}

params: IUploadParams & {
add_to_news?: number;
clickable_stickers?: string;
group_id?: number;
link_text: string;
link_url: string;
reply_to_story?: string;
user_ids?: string | string[];
}

__namedParameters: {
forceBuffer: boolean;
formData: FormData;
timeout: number;
}

params: IUploadParams & {
album_id?: number;
compression?: number;
description?: string;
group_id?: number;
is_private?: number;
link?: string;
name?: string;
no_comments?: number;
privacy_comment?: string;
privacy_view?: string;
repeat?: number;
wallpost?: number;
}

params: IUploadParams & {
group_id?: number;
tags?: string;
title?: string;
}

params: IUploadParams & {
caption?: string;
group_id?: number;
latitude?: number;
longitude?: number;
user_id?: number;
}