\Threema\MsgApi\MessagesDeliveryReceipt

Abstract base class of messages that can be sent with end-to-end encryption via Threema.

Summary

Methods
Properties
Constants
getTypeCode()
__construct()
getReceiptType()
getReceiptTypeName()
getAckedMessageIds()
__toString()
No public properties found
TYPE_CODE
No protected methods found
No protected properties found
N/A
No private methods found
$receiptTypesToNames
$receiptType
$ackedMessageIds
N/A

Constants

TYPE_CODE

TYPE_CODE

Properties

$receiptTypesToNames

$receiptTypesToNames : array

map type => text

Type

array

$receiptType

$receiptType : integer

the type of this receipt

Type

integer

$ackedMessageIds

$ackedMessageIds : array<mixed,string>

list of message IDs acknowledged by this delivery receipt

Type

array<mixed,string>

Methods

getTypeCode()

getTypeCode() : integer

Get the message type code of this message.

Returns

integer —

message type code

__construct()

__construct(integer  $receiptType, array  $ackedMessageIds) 

create instance

Parameters

integer $receiptType

the type of this receipt

array $ackedMessageIds

list of message IDs acknowledged by this delivery receipt

getReceiptType()

getReceiptType() : integer

Get the type of this delivery receipt as a numeric code (e.g. 1, 2, 3).

Returns

integer

getReceiptTypeName()

getReceiptTypeName() : string

Get the type of this delivery receipt as a string (e.g. 'received', 'read', 'userack').

Returns

string

getAckedMessageIds()

getAckedMessageIds() : array

Get the acknowledged message ids

Returns

array

__toString()

__toString() : string

Convert to string

Returns

string