Interface FriendsGetParams

interface FriendsGetParams {
    count?: number;
    fields?: UsersFields[];
    list_id?: number;
    offset?: number;
    order?: "name" | "mobile" | "hints" | "random" | "smart";
    ref?: string;
    user_id?: number;
    [key: string]: any;
}

Indexable

[key: string]: any

Properties

count? fields? list_id? offset? order? ref? user_id?

Properties

Optional count

count?: number

Number of friends to return.

Optional fields

fields?: UsersFields[]

Optional list_id

list_id?: number

ID of the friend list returned by the [vk.com/dev/friends.getLists|friends.getLists] method to be used as the source. This parameter is taken into account only when the uid parameter is set to the current user ID. This parameter is available only for [vk.com/dev/standalone|desktop applications].

Optional offset

offset?: number

Offset needed to return a specific subset of friends.

Optional order

order?: "name" | "mobile" | "hints" | "random" | "smart"

Sort order: , 'name' - by name (enabled only if the 'fields' parameter is used), 'hints' - by rating, similar to how friends are sorted in My friends section, , This parameter is available only for [vk.com/dev/standalone|desktop applications].

Optional ref

ref?: string

Optional user_id

user_id?: number

User ID. By default, the current user ID.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc