UpdateEvent

public class UpdateEvent : CommunicationEvent<UpdateEventData>

UpdateEvent provides a generic implementation for updating a CoatyObject.

Static Factory Methods.

  • Create an UpdateEvent instance for the given object.

    The object type of the given object must be a non-empty string that does not contain the following characters: NULL (U+0000), # (U+0023), + (U+002B), / (U+002F).

    Throws

    if object type of given object is invalid

    Declaration

    Swift

    public static func with(object: CoatyObject) throws -> UpdateEvent

    Parameters

    object

    the object with properties to be updated

    Return Value

    an Update event with the given parameters

  • Respond to an observed Update event by sending the given Complete event.

    Declaration

    Swift

    public func complete(completeEvent: CompleteEvent)

    Parameters

    completeEvent

    a Complete event.

Codable methods.

  • Undocumented

    Declaration

    Swift

    public required init(from decoder: Decoder) throws

  • Undocumented

    Declaration

    Swift

    override public func encode(to encoder: Encoder) throws