send(_:completionHandler:)

Sends a sticker.

Declaration

func send(_ sticker: MSSticker, completionHandler: (@Sendable ((any Error)?) -> Void)? = nil)

func send(_ sticker: MSSticker) async throws

Parameters

sticker:
The sticker to send.
completionHandler:
A block that’s called as soon as the message starts sending. This block is passed the following parameter:
error
An error object. If an error occurred, this object contains information about the error; otherwise, it’s set to nil. An error occurs if the user hasn’t recently interacted with your app.

Mentioned in

Adding Sticker packs and iMessage apps to the system Stickers app, Messages camera, and FaceTime

Discussion

important:

You can call this method from synchronous code using a completion handler, as shown on this page, or you can call it as an asynchronous method that has the following declaration:

func send(_ sticker: MSSticker) async throws

For information about concurrency and asynchronous code in Swift, see Calling Objective-C APIs Asynchronously.

This method starts sending the sticker automatically, without any additional user interactions. You can call this method only in response to a user action while in the MSMessagesAppPresentationContext.messages context.

When calling this method, the following rules apply:

If the app isn’t visible, the send fails with a MSMessageErrorCode.sendWhileNotVisible error code.
If the app hasn’t registered a recent touch interaction from the user, the send fails with a MSMessageErrorCode.sendWithoutRecentInteraction error code.
If the app is in the MSMessagesAppPresentationContext.media context, the send fails with an MSMessageErrorCode.apiUnavailableInPresentationContext error.

This method operates asynchronously. Although the method returns immediately, the actual work is deferred and performed in the background. As soon as the message starts to send, the system calls the completion block on a background queue.