Package 

Class BsLogCancelOrderEvent.Builder

    • Method Summary

      Modifier and Type Method Description
      final <ERROR CLASS> init(Context context) init is required to pass context to the SDK method and log the event.
      final <ERROR CLASS> setOrderId(String order_id) setOrderId can be used to log the orderId the event is logged for.
      final <ERROR CLASS> )>addOrderItemTypesList(<ERROR CLASS><String> item_types) setOrderItemTypes is required to provide the list of item types that are present in the order being cancelled
      final <ERROR CLASS> addOrderItemTypesList(String item_types_list)
      final <ERROR CLASS> addOrderItemType(ItemType item_type)
      final <ERROR CLASS> addOrderItemType(String item_type)
      final <ERROR CLASS> setCancelReason(String reason) setCancelReason is required to define the reason for which the item is being cancelled.
      final <ERROR CLASS> setMeta(Object meta) You can pass any type of value in setMeta.
      final <ERROR CLASS> updateImmediately(Boolean update_immediately) updateImmediately is responsible for updating the values ot the backend immediately.
      final <ERROR CLASS> build() build will validate all of the values provided and if passes will call the track function and queue the events based on it's updateImmediately value and also on the user's network resources.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • init

         final <ERROR CLASS> init(Context context)

        init is required to pass context to the SDK method and log the event. if not provided, it will throw an exception on runtime.

      • setOrderId

         final <ERROR CLASS> setOrderId(String order_id)

        setOrderId can be used to log the orderId the event is logged for. if the order ID is not there then it is recommended to include the unique cartId for the cart items so that they can be tracked. In case the cart Id is also not there, you can use the userId as a unique element for the order.

      • addOrderItemTypesList

         final <ERROR CLASS> )>addOrderItemTypesList(<ERROR CLASS><String> item_types)

        setOrderItemTypes is required to provide the list of item types that are present in the order being cancelled

      • setCancelReason

         final <ERROR CLASS> setCancelReason(String reason)

        setCancelReason is required to define the reason for which the item is being cancelled.

      • setMeta

         final <ERROR CLASS> setMeta(Object meta)

        You can pass any type of value in setMeta. It is for developer and partners to log additional information with the log that they find would be helpful for logging and providing more context to the log. Default value for the meta is null.

      • updateImmediately

         final <ERROR CLASS> updateImmediately(Boolean update_immediately)

        updateImmediately is responsible for updating the values ot the backend immediately. By default this is set to false or whatever the developer has set in the SDK initialisation block. This differs the time for which the logs will be logged, if true, the SDK will log the content instantly and if false it will wait till the end of user session which is whenever the app goes into background.

      • build

         final <ERROR CLASS> build()

        build will validate all of the values provided and if passes will call the track function and queue the events based on it's updateImmediately value and also on the user's network resources.