Class VKAudio

constructor

• new VKAudio(__namedParameters: VKAudioOpts): VKAudio

  Parameters

  • __namedParameters: VKAudioOpts

  Returns VKAudio

client

lang

authParams

• get authParams(): string

  Returns string

add

• add(ownerId: number, audioId: number): Promise<AddAudioResult>

  Parameters

  • ownerId: number
  • audioId: number

  Returns Promise<AddAudioResult>

createBody

• createBody(data: Record<string, string | undefined>): URLSearchParams

  Parameters

  • data: Record<string, string | undefined>

  Returns URLSearchParams

delete

• delete(ownerId: number, audioId: number): Promise<boolean>

  Parameters

  • ownerId: number
  • audioId: number

  Returns Promise<boolean>

getSearchSuggestion

• getSearchSuggestion(query: string): Promise<string[]>

  Get search suggestions

  Parameters

  • query: string

    Search query

  Returns Promise<string[]>

getSection

• getSection(sectionId: string, startFrom?: string): Promise<AudioSection>

  Get section

  Parameters

  • sectionId: string

    Id of the section

  • OptionalstartFrom: string

    Id of the offset

  Returns Promise<AudioSection>

getSections

• getSections(ownerId?: string): Promise<AudioSectionList>

  Get available sections

  Parameters

  • OptionalownerId: string

    User or community id. If not specified, current user audios will be returned

  Returns Promise<AudioSectionList>

getSectionsWithBlocks

• getSectionsWithBlocks(ownerId?: string): Promise<AudioSectionListWithBlocks>

  Get available sections with blocks

  Parameters

  • OptionalownerId: string

    User or community id. If not specified, current user audios will be returned

  Returns Promise<AudioSectionListWithBlocks>

rawAdd

• rawAdd(ownerId: number, audioId: number): Promise<AudioAddResult>

  Parameters

  • ownerId: number
  • audioId: number

  Returns Promise<AudioAddResult>

rawDelete

• rawDelete(ownerId: number, audioId: number): Promise<AudioDeleteResult>

  Parameters

  • ownerId: number
  • audioId: number

  Returns Promise<AudioDeleteResult>

rawGetSection

• rawGetSection(
      sectionId: string,
      startFrom?: string,
  ): Promise<GetAudioSectionData>

  Get section raw data

  Parameters

  • sectionId: string

    Id of the section

  • OptionalstartFrom: string

    Id of the offset

  Returns Promise<GetAudioSectionData>

rawGetSections

• rawGetSections(ownerId?: string, needBlocks?: false): Promise<GetAudioData>

  Get available sections raw data

  Parameters

  • OptionalownerId: string

    User or community id. If not specified, current user audios will be returned

  • OptionalneedBlocks: false

    If true, will return blocks data

  Returns Promise<GetAudioData>

• rawGetSections(
      ownerId?: string,
      needBlocks?: true,
  ): Promise<AudioWithBlocksData>

  Get available sections raw data

  Parameters

  • OptionalownerId: string

    User or community id. If not specified, current user audios will be returned

  • OptionalneedBlocks: true

    If true, will return blocks data

  Returns Promise<AudioWithBlocksData>

• rawGetSections(
      ownerId: string | undefined,
      needBlocks: boolean,
  ): Promise<GetAudioData | AudioWithBlocksData>

  Get available sections raw data

  Parameters

  • ownerId: string | undefined

    User or community id. If not specified, current user audios will be returned

  • needBlocks: boolean

    If true, will return blocks data

  Returns Promise<GetAudioData | AudioWithBlocksData>

rawSearchAudio

• rawSearchAudio(query: string, offset?: number): Promise<SearchAudioData>

  Search audio

  Parameters

  • query: string

    Search query

  • Optionaloffset: number

    Offset for search results

  Returns Promise<SearchAudioData>

request

• request<T>(
      method: VKAudioMethod,
      body?: URLSearchParams,
  ): Promise<VKAudioResult<T>>

  Type Parameters

  • T

  Parameters

  • method: VKAudioMethod
  • Optionalbody: URLSearchParams

  Returns Promise<VKAudioResult<T>>

searchAudio

• searchAudio(query: string, offset?: number): Promise<SearchAudioResult>

  Parameters

  • query: string
  • Optionaloffset: number

  Returns Promise<SearchAudioResult>