Yurba.js Documentation
    Preparing search index...

    Class DialogResource

    Ресурс для роботи з діалогами

    Hierarchy

    • BaseResource
      • DialogResource
    Index

    Dialogs

    get

    Other

    constructor client create members buildPaginatedEndpoint handleApiError request validateConstraints validateDialogId validatePage validateRequired validateStringLength

    Dialogs

    get: { all: () => Promise<Dialog[]> }

    Отримати всі діалоги

    0.1.7

    Список діалогів

    Other

    • Parameters

      • client: REST

      Returns DialogResource

    client: REST
    create: (
        name: string,
        type: Dtype,
        options?: { description?: string },
    ) => Promise<Dialog>

    Створити новий діалог

    Type declaration

      • (name: string, type: Dtype, options?: { description?: string }): Promise<Dialog>

      • Parameters

        • name: string

          Назва діалогу (макс. 330 символів)

        • type: Dtype

          Тип діалогу (тільки Channel або Group)

        • Optionaloptions: { description?: string }

          Додаткові опції

          • Optionaldescription?: string

            Опис діалогу (макс. 330 символів)

        Returns Promise<Dialog>

        Створений діалог

    Може кинути: auth_failed, invalid_type, upload_error або інші

    members: {
        add: (dialogId: number, userId: number) => Promise<any>;
        get: (dialogId: number, page?: number) => Promise<DialogMember[]>;
        remove: (dialogId: number, userId: number) => Promise<any>;
    }

    Методи для роботи з учасниками діалогу

    Type declaration

    • add: (dialogId: number, userId: number) => Promise<any>

      Додати користувача до діалогу

    • get: (dialogId: number, page?: number) => Promise<DialogMember[]>

      Отримати учасників діалогу

      Може кинути: not_found, auth_failed, invalid_page або інші

    • remove: (dialogId: number, userId: number) => Promise<any>

      Видалити користувача з діалогу

    • Build paginated endpoint URL

      Parameters

      • baseEndpoint: string

        Base endpoint

      • Optionalpage: number

        Page number

      • Optionallimit: number

        Items per page

      Returns string

      Formatted endpoint with pagination

    • Handle API errors with consistent error mapping

      Parameters

      • err: any
      • Optionalendpoint: string

      Returns never

    • Execute request with automatic error handling and type safety

      Type Parameters

      • T

      Parameters

      • method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE"

        HTTP method

      • endpoint: string

        API endpoint

      • Optionaldata: any

        Request data

      • Optionalconfig: RequestConfig

        Request configuration

      Returns Promise<T>

      Promise resolving to typed response

    • Validate parameter constraints

      Parameters

      • value: any

        Value to validate

      • constraints: {
            enum?: any[];
            max?: number;
            maxLength?: number;
            min?: number;
            minLength?: number;
            pattern?: RegExp;
        }

        Validation constraints

      • paramName: string

        Parameter name for error messages

      Returns void

    • Validate dialog ID

      Parameters

      • dialogId: number

      Returns void

    • Validate page number

      Parameters

      • page: number

      Returns void

    • Validate required parameters

      Parameters

      • params: Record<string, any>

        Parameters to validate

      • required: string[]

        Required parameter names

      Returns void

      If any required parameter is missing

    • Validate string length

      Parameters

      • value: string
      • maxLength: number
      • fieldName: string

      Returns void

    Settings

    Member Visibility

    On This Page

    Dialogs
    Other