Function setRestrictionState

  • setRestrictionState(restrictionState?): void

  • Tells Contextual Commerce to enter/exit a restricted state in which no campaign can be shown to the shopper. Note that this does not apply to inline campaigns, which will not be hidden while in a restricted state.

    The initial state of the SDK is unrestricted upon activation.

    Parameters

    Returns void

    Placement

    This function should be called:

    • When entering a situation whereby a campaign should not be shown.
    • When exiting a situation whereby a campaign should not be shown.

    @param[restrictionState] The updated RestrictionState value indicating whether a campaign can be shown.

Settings

Member Visibility