-
public final class BsLogDeliveryEvent.BuilderBsLogDeliveryEvent is used to log the status for the delivery. It can be used to log the delivered status of the order or a partial order. Details about the items in the specific delivery should be provided in the catalog.
-
-
Method Summary
Modifier and Type Method Description final StringgetOrder_id()final UnitsetOrder_id(String order_id)final StringgetDelivery_id()final UnitsetDelivery_id(String delivery_id)final StringgetAction()final UnitsetAction(String action)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 is required to associate the rating obtained for the order. final <ERROR CLASS>setDeliveryId(String delivery_id)setDeliveryId is required to associate the rating obtained for the order. final <ERROR CLASS>setDeliveryAction(DeliveryAction action)setDeliveryAction is required to set the delivery action for the log. final <ERROR CLASS>setDeliveryAction(String action)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. -
-
Method Detail
-
getOrder_id
final String getOrder_id()
-
setOrder_id
final Unit setOrder_id(String order_id)
-
getDelivery_id
final String getDelivery_id()
-
setDelivery_id
final Unit setDelivery_id(String delivery_id)
-
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 is required to associate the rating obtained for the order. OrderId should be a valid orderId and can be tracked from the catalog
-
setDeliveryId
final <ERROR CLASS> setDeliveryId(String delivery_id)
setDeliveryId is required to associate the rating obtained for the order. deliveryId should be a valid deliveryId and can be tracked from the catalog for the items in that specific delivery.
-
setDeliveryAction
final <ERROR CLASS> setDeliveryAction(DeliveryAction action)
setDeliveryAction is required to set the delivery action for the log. For the order being prepared for delivery or left the shipment center or delivered to the customer.
-
setDeliveryAction
final <ERROR CLASS> setDeliveryAction(String action)
-
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.
-
-
-
-