View on GitHub
Install in Dash
MessagingApi Protocol Reference
MessagingApi
public protocol MessagingApi : BaseApiUndocumented
-
getAll(byIds:)Default implementationGet all messages by ids.
Default Implementation
Declaration
Swift
func getAll(byIds ids: [ObjectIdConvertible]) -> Single<[Message]>Parameters
idsFilter by message ids, as
[MessagingObjectId]or[String]format.Return Value
[Message]. -
get(byId:)Default implementationGet message by id.
Default Implementation
Declaration
Swift
func get(byId id: ObjectIdConvertible) -> Single<Message>Parameters
idFilter by message id, as
MessagingObjectIdorStringformat.Return Value
-
getAllDecrypted(byIds:credentials:)Default implementationGet all messages by ids decrypted.
Default Implementation
Declaration
Swift
func getAllDecrypted(byIds ids: [ObjectIdConvertible], credentials: Credentials) -> Single<[Message]>Parameters
idsFilter by message ids, as
[MessagingObjectId]or[String]format.credentialsAccount credenials, as
ChainObjectorStringformat.Return Value
[Message]. -
getDecrypted(byId:credentials:)Default implementationGet message by id decrypted.
Default Implementation
Declaration
Swift
func getDecrypted(byId id: ObjectIdConvertible, credentials: Credentials) -> Single<Message>Parameters
idFilter by message id, as
MessagingObjectIdorStringformat.credentialsAccount credenials, as
ChainObjectorStringformat.Return Value
-
findAll(bySender:limit:)Default implementationFind all messages by sender.
Default Implementation
Declaration
Swift
func findAll(bySender sender: AccountObjectIdConvertible, limit: Int) -> Single<[Message]>Parameters
senderFilter by sender account id, as
AccountObjectIdorStringformat.limitMax items to return.
Return Value
[Message]. -
findAll(byReceiver:limit:)Default implementationFind all messages by receiver.
Default Implementation
Declaration
Swift
func findAll(byReceiver receiver: AccountObjectIdConvertible, limit: Int) -> Single<[Message]>Parameters
receiverFilter by receiver account id, as
AccountObjectIdorStringformat.limitMax items to return.
Return Value
[Message]. -
findAllSenderDecrypted(_:limit:)Default implementationFind all messages decrypted by sender.
Default Implementation
Declaration
Swift
func findAllSenderDecrypted(_ credentials: Credentials, limit: Int) -> Single<[Message]>Parameters
credentialsAccount credenials, as
ChainObjectorStringformat.limitMax items to return.
Return Value
[Message]. -
findAllReceiverDecrypted(_:limit:)Default implementationFind all messages decrypted by receiver.
Default Implementation
Declaration
Swift
func findAllReceiverDecrypted(_ credentials: Credentials, limit: Int) -> Single<[Message]>Parameters
credentialsAccount credenials, as
ChainObjectorStringformat.limitMax items to return.
Return Value
[Message]. -
findAllResponses(bySender:limit:)Default implementationFind all messages responses.
Default Implementation
Declaration
Swift
func findAllResponses(bySender sender: AccountObjectIdConvertible, limit: Int) -> Single<[MessageResponse]>Parameters
senderFilter by sender account id, as
AccountObjectIdorStringformat.limitMax items to return.
Return Value
[MessageResponse]. -
findAllResponses(byReceiver:limit:)Default implementationFind all messages responses.
Default Implementation
Declaration
Swift
func findAllResponses(byReceiver receiver: AccountObjectIdConvertible, limit: Int) -> Single<[MessageResponse]>Parameters
receiverFilter by receiver account id, as
AccountObjectIdorStringformat.limitMax items to return.
Return Value
[MessageResponse]. -
createMessage(to:message:credentials:)Default implementationCreate message operation, send a message to one receiver.
Default Implementation
Declaration
Swift
func createMessage(to: AccountObjectIdConvertible, message: String, credentials: Credentials) -> Single<SendMessageOperation>Parameters
toreceiver account id, as
AccountObjectIdorStringformat.messageMessage to send.
credentialsSender account credentials.
Return Value
-
createMessage(_:credentials:)Default implementationCreate message operation, send messages to multiple receivers.
Default Implementation
Declaration
Swift
func createMessage(_ payloads: [Pair<AccountObjectIdConvertible, String>], credentials: Credentials) -> Single<SendMessageOperation>Parameters
payloadsPairs of receiver account id, as
AccountObjectIdorStringformat and message.credentialsSender account credentials.
Return Value
-
send(to:message:credentials:)Default implementationSend a message to one receiver.
Default Implementation
Declaration
Swift
func send(to: AccountObjectIdConvertible, message: String, credentials: Credentials) -> Single<TransactionConfirmation>Parameters
toreceiver account id, as
AccountObjectIdorStringformat.messageMessage to send.
credentialsSender account credentials.
Return Value
-
createUnencryptedMessage(to:message:credentials:)Default implementationCreate unencrypted message operation, send a message to one receiver.
Default Implementation
Declaration
Swift
func createUnencryptedMessage(to: AccountObjectIdConvertible, message: String, credentials: Credentials) -> Single<SendMessageOperation>Parameters
toreceiver account id, as
AccountObjectIdorStringformat.messageMessage to send.
credentialsSender account credentials.
Return Value
-
createUnencryptedMessage(_:credentials:)Default implementationCreate unencrypted message operation, send messages to multiple receivers.
Default Implementation
Declaration
Swift
func createUnencryptedMessage(_ payloads: [Pair<AccountObjectIdConvertible, String>], credentials: Credentials) -> Single<SendMessageOperation>Parameters
payloadsPairs of receiver account id, as
AccountObjectIdorStringformat and message.credentialsSender account credentials.
Return Value
-
sendUnencrypted(to:message:credentials:)Default implementationSend unencrypted message to one receiver.
Default Implementation
Declaration
Swift
func sendUnencrypted(to: AccountObjectIdConvertible, message: String, credentials: Credentials) -> Single<TransactionConfirmation>Parameters
toreceiver account id, as
AccountObjectIdorStringformat.messageMessage to send.
credentialsSender account credentials.
Return Value