itd-api / RealtimeDeps

Interface: RealtimeDeps

Defined in: realtime/stream.ts:149

Что поток получает от клиента.

Properties

baseHeaders

baseHeaders: (url) => Promise<Headers>;

Defined in: realtime/stream.ts:153

Общие заголовки клиента для адреса — см. TransportContext.baseHeaders.

Parameters

url

string

Returns

Promise<Headers>

---

baseUrl

baseUrl: string;

Defined in: realtime/stream.ts:150

---

fetch

fetch: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Defined in: realtime/stream.ts:151

Call Signature

(input, init?): Promise<Response>;

MDN Reference

Parameters

input

URL | RequestInfo

init?

RequestInit

Returns

Promise<Response>

Call Signature

(input, init?): Promise<Response>;

MDN Reference

Parameters

input

string | URL | Request

init?

RequestInit

Returns

Promise<Response>

---

fetchUnreadCount

fetchUnreadCount: () => Promise<number>;

Defined in: realtime/stream.ts:162

Загружает начальное число непрочитанных.

Returns

Promise<number>

---

getAuthIdentity?

optional getAuthIdentity?: () => AuthIdentity;

Defined in: realtime/stream.ts:155

Идентификаторы аккаунта и сессии создавшего поток клиента.

Returns

AuthIdentity

---

getAuthScope?

optional getAuthScope?: () => string;

Defined in: realtime/stream.ts:157

Непрозрачная область авторизации создавшего поток клиента.

Returns

string

---

getToken

getToken: () => Promise<string | null>;

Defined in: realtime/stream.ts:158

Returns

Promise<string | null>

---

logger?

optional logger?: Logger;

Defined in: realtime/stream.ts:165

---

onClose?

optional onClose?: () => void;

Defined in: realtime/stream.ts:164

Вызывается при явном закрытии потока.

Returns

void

---

refresh

refresh: () => Promise<boolean>;

Defined in: realtime/stream.ts:160

Обновляет токен после отказа авторизации. Возвращает true, если удалось.

Returns

Promise<boolean>