1. class
  2. GingTeam
  3. \
  4. Telegram
  5. \
  6. Type
  7. \
  8. WebhookInfo

WebhookInfo

class WebhookInfo

Describes the current status of a webhook.

Methods

__construct(string $url, bool $has_custom_certificate, int $pending_update_count, string|null $ip_address = null, int|null $last_error_date = null, string|null $last_error_message = null, int|null $last_synchronization_error_date = null, int|null $max_connections = null, string[]|null $allowed_updates = null)

No description

string
getUrl()

Webhook URL, may be empty if webhook is not set up.

bool
getHasCustomCertificate()

True, if a custom certificate was provided for webhook certificate checks.

int
getPendingUpdateCount()

Number of updates awaiting delivery.

string|null
getIpAddress()

Optional. Currently used webhook IP address.

int|null
getLastErrorDate()

Optional. Unix time for the most recent error that happened when trying to deliver an update via webhook.

string|null
getLastErrorMessage()

Optional. Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook.

int|null
getLastSynchronizationErrorDate()

Optional. Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters.

int|null
getMaxConnections()

Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery.

array|null
getAllowedUpdates()

Optional. A list of update types the bot is subscribed to. Defaults to all update types except chat_member.

Details

at line 21
__construct(string $url, bool $has_custom_certificate, int $pending_update_count, string|null $ip_address = null, int|null $last_error_date = null, string|null $last_error_message = null, int|null $last_synchronization_error_date = null, int|null $max_connections = null, string[]|null $allowed_updates = null)

No description

Parameters

string $url
bool $has_custom_certificate
int $pending_update_count
string|null $ip_address
int|null $last_error_date
string|null $last_error_message
int|null $last_synchronization_error_date
int|null $max_connections
string[]|null $allowed_updates

at line 37
string getUrl()

Webhook URL, may be empty if webhook is not set up.

Return Value

string

at line 45
bool getHasCustomCertificate()

True, if a custom certificate was provided for webhook certificate checks.

Return Value

bool

at line 53
int getPendingUpdateCount()

Number of updates awaiting delivery.

Return Value

int

at line 61
string|null getIpAddress()

Optional. Currently used webhook IP address.

Return Value

string|null

at line 69
int|null getLastErrorDate()

Optional. Unix time for the most recent error that happened when trying to deliver an update via webhook.

Return Value

int|null

at line 77
string|null getLastErrorMessage()

Optional. Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook.

Return Value

string|null

at line 85
int|null getLastSynchronizationErrorDate()

Optional. Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters.

Return Value

int|null

at line 93
int|null getMaxConnections()

Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery.

Return Value

int|null

at line 103
array|null getAllowedUpdates()

Optional. A list of update types the bot is subscribed to. Defaults to all update types except chat_member.

Return Value

array|null