Interface SubscribeNotificationRequestBuilder

All Superinterfaces:
PolicyRequestBuilder<SubscribeNotificationRequest.RequestType,SubscribeNotificationRequestBuilder>

public interface SubscribeNotificationRequestBuilder extends PolicyRequestBuilder<SubscribeNotificationRequest.RequestType,SubscribeNotificationRequestBuilder>
Builder to construct well formed instance of SubscribeNotificationRequest
  • Method Details

    • withPreferences

      SubscribeNotificationRequestBuilder withPreferences(Collection<String> preferences)
      Sets the preferences for this PolicyRequest. This is a optional filed
    • If not specified,then all the preferences will be subscribed for.
    • Parameters:
      preferences - set of preferences to be subscribed/un-subscribed (eg. [Language, Channel])
      Returns:
      the current builder to support chaining construct.
    • withExpiryTime

      Sets expiry time in this PolicyRequest. This is a optional filed
    • The absence of this field in the request will lead to infinite subscription for the subscriber notification

      Equivalent diameter AVP : Expiry-Time

    • Parameters:
      expiryTime - date when subscription should cease
      Returns:
      the current builder to support chaining construct.
    • withDataReferences

      SubscribeNotificationRequestBuilder withDataReferences(Collection<Integer> dataReferences)
      Sets the data-references in the SubscribeNotificationRequest. Data-references are numbers sent by the diameter which map to a preference or extended info in ECE.

      Equivalent diameter AVP : Data-Reference

      Parameters:
      dataReferences - collection of data reference numbers. Eg: [51,52]
      Returns:
      the current builder to support chaining construct.
    • withIsUserDataRequested

      SubscribeNotificationRequestBuilder withIsUserDataRequested(boolean isUserDataRequested)
      Sets isUserDataRequested flag in the SubscribeNotificationRequest. This is an optional field. If not specified, subscribe notification response will not contain the user data

      Equivalent diameter AVP : Send-Data-Indication

      Parameters:
      isUserDataRequested - true if response should contain user data, false otherwise
      Returns:
      the current builder to support chaining construct.