docs(client): added info about "send when online" scheduled messages

This commit is contained in:
teidesu 2021-05-25 11:58:14 +03:00
parent 60162c88bc
commit 3845153871
6 changed files with 39 additions and 0 deletions

View file

@ -1835,6 +1835,9 @@ export interface TelegramClient extends BaseTelegramClient {
/** /**
* If set, the message will be scheduled to this date. * If set, the message will be scheduled to this date.
* When passing a number, a UNIX time in ms is expected. * When passing a number, a UNIX time in ms is expected.
*
* You can also pass `0x7FFFFFFE`, this will send the message
* once the peer is online
*/ */
schedule?: Date | number schedule?: Date | number
} }
@ -1901,6 +1904,9 @@ export interface TelegramClient extends BaseTelegramClient {
* If set, the forwarding will be scheduled to this date * If set, the forwarding will be scheduled to this date
* (also applies to caption message). * (also applies to caption message).
* When passing a number, a UNIX time in ms is expected. * When passing a number, a UNIX time in ms is expected.
*
* You can also pass `0x7FFFFFFE`, this will send the message
* once the peer is online
*/ */
schedule?: Date | number schedule?: Date | number
@ -2206,6 +2212,9 @@ export interface TelegramClient extends BaseTelegramClient {
/** /**
* If set, the message will be scheduled to this date. * If set, the message will be scheduled to this date.
* When passing a number, a UNIX time in ms is expected. * When passing a number, a UNIX time in ms is expected.
*
* You can also pass `0x7FFFFFFE`, this will send the message
* once the peer is online
*/ */
schedule?: Date | number schedule?: Date | number
@ -2282,6 +2291,9 @@ export interface TelegramClient extends BaseTelegramClient {
/** /**
* If set, the message will be scheduled to this date. * If set, the message will be scheduled to this date.
* When passing a number, a UNIX time in ms is expected. * When passing a number, a UNIX time in ms is expected.
*
* You can also pass `0x7FFFFFFE`, this will send the message
* once the peer is online
*/ */
schedule?: Date | number schedule?: Date | number
@ -2350,6 +2362,9 @@ export interface TelegramClient extends BaseTelegramClient {
/** /**
* If set, the message will be scheduled to this date. * If set, the message will be scheduled to this date.
* When passing a number, a UNIX time in ms is expected. * When passing a number, a UNIX time in ms is expected.
*
* You can also pass `0x7FFFFFFE`, this will send the message
* once the peer is online
*/ */
schedule?: Date | number schedule?: Date | number
@ -2422,6 +2437,9 @@ export interface TelegramClient extends BaseTelegramClient {
/** /**
* If set, the message will be scheduled to this date. * If set, the message will be scheduled to this date.
* When passing a number, a UNIX time in ms is expected. * When passing a number, a UNIX time in ms is expected.
*
* You can also pass `0x7FFFFFFE`, this will send the message
* once the peer is online
*/ */
schedule?: Date | number schedule?: Date | number

View file

@ -40,6 +40,9 @@ export async function forwardMessages(
/** /**
* If set, the message will be scheduled to this date. * If set, the message will be scheduled to this date.
* When passing a number, a UNIX time in ms is expected. * When passing a number, a UNIX time in ms is expected.
*
* You can also pass `0x7FFFFFFE`, this will send the message
* once the peer is online
*/ */
schedule?: Date | number schedule?: Date | number
} }
@ -109,6 +112,9 @@ export async function forwardMessages(
* If set, the forwarding will be scheduled to this date * If set, the forwarding will be scheduled to this date
* (also applies to caption message). * (also applies to caption message).
* When passing a number, a UNIX time in ms is expected. * When passing a number, a UNIX time in ms is expected.
*
* You can also pass `0x7FFFFFFE`, this will send the message
* once the peer is online
*/ */
schedule?: Date | number schedule?: Date | number
@ -170,6 +176,9 @@ export async function forwardMessages(
/** /**
* If set, the message will be scheduled to this date. * If set, the message will be scheduled to this date.
* When passing a number, a UNIX time in ms is expected. * When passing a number, a UNIX time in ms is expected.
*
* You can also pass `0x7FFFFFFE`, this will send the message
* once the peer is online
*/ */
schedule?: Date | number schedule?: Date | number

View file

@ -35,6 +35,9 @@ export async function sendCopy(
/** /**
* If set, the message will be scheduled to this date. * If set, the message will be scheduled to this date.
* When passing a number, a UNIX time in ms is expected. * When passing a number, a UNIX time in ms is expected.
*
* You can also pass `0x7FFFFFFE`, this will send the message
* once the peer is online
*/ */
schedule?: Date | number schedule?: Date | number

View file

@ -46,6 +46,9 @@ export async function sendMediaGroup(
/** /**
* If set, the message will be scheduled to this date. * If set, the message will be scheduled to this date.
* When passing a number, a UNIX time in ms is expected. * When passing a number, a UNIX time in ms is expected.
*
* You can also pass `0x7FFFFFFE`, this will send the message
* once the peer is online
*/ */
schedule?: Date | number schedule?: Date | number

View file

@ -46,6 +46,9 @@ export async function sendMedia(
/** /**
* If set, the message will be scheduled to this date. * If set, the message will be scheduled to this date.
* When passing a number, a UNIX time in ms is expected. * When passing a number, a UNIX time in ms is expected.
*
* You can also pass `0x7FFFFFFE`, this will send the message
* once the peer is online
*/ */
schedule?: Date | number schedule?: Date | number

View file

@ -51,6 +51,9 @@ export async function sendText(
/** /**
* If set, the message will be scheduled to this date. * If set, the message will be scheduled to this date.
* When passing a number, a UNIX time in ms is expected. * When passing a number, a UNIX time in ms is expected.
*
* You can also pass `0x7FFFFFFE`, this will send the message
* once the peer is online
*/ */
schedule?: Date | number schedule?: Date | number