iOS & macOS Charting Documentation - SciChart iOS & macOS Charts SDK v4.x

ISCIEventAggregator

@protocol ISCIEventAggregator <NSObject>

Defines the interface to a lightweight Event Aggregator used within SciChart for inter-component communication.

  • Subscribe to a message type with the given destination and delivery action.

    Declaration

    Objective-C

    - (nonnull SCIMessageSubscriptionToken *)subscribeTo:(nonnull Class)messageType
                                                  action:(nonnull SCIAction1)
                                                             deliveryAction;

    Parameters

    messageType

    Type of message.

    deliveryAction

    Action to invoke when message is delivered.

    Return Value

    SCIMessageSubscriptionToken used to unsubscribe from messages.

  • Subscribe to a message type with the given destination and delivery action.

    Declaration

    Objective-C

    - (nonnull SCIMessageSubscriptionToken *)
               subscribeTo:(nonnull Class)messageType
                    action:(nonnull SCIAction1)deliveryAction
        useStrongReference:(BOOL)useStrongReferences;

    Parameters

    messageType

    Type of message.

    deliveryAction

    Action to invoke when message is delivered.

    useStrongReferences

    Use strong references to destination and deliveryAction.

    Return Value

    SCIMessageSubscriptionToken used to unsubscribe from messages.

  • Unsubscribe from a particular message type.

    Declaration

    Objective-C

    - (void)unsubscibe:(nonnull SCIMessageSubscriptionToken *)subscriptionToken;

    Parameters

    subscriptionToken

    Type of message.

  • Publish a message to any subscribers.

    Declaration

    Objective-C

    - (void)publish:(nonnull id<ISCIMessage>)message;

    Parameters

    message

    The published message.