.. _module-splice-api-featuredapprightv1-64680: Splice.Api.FeaturedAppRightV1 ============================= The API for featured apps to record their activity\. Interfaces ---------- .. _type-splice-api-featuredapprightv1-featuredappactivitymarker-46407: **interface** `FeaturedAppActivityMarker `_ A marker created by a featured application for activity generated from that app\. This is used to record activity other than amulet transfers, which have built\-in support for recording featured app activity\. **viewtype** `FeaturedAppActivityMarkerView `_ + **Choice** Archive Controller\: Signatories of implementing template Returns\: () (no fields) .. _type-splice-api-featuredapprightv1-featuredappright-34177: **interface** `FeaturedAppRight `_ An interface for contracts allowing application providers to record their featured activity\. Note that most instances of amulet will likely define some fair usage constraints\. **viewtype** `FeaturedAppRightView `_ + **Choice** Archive Controller\: Signatories of implementing template Returns\: () (no fields) + .. _type-splice-api-featuredapprightv1-featuredapprightcreateactivitymarker-36646: **Choice** `FeaturedAppRight_CreateActivityMarker `_ Record activity due to a featured app\. Controller\: (DA\.Internal\.Record\.getField @\"provider\" (view this)) Returns\: `FeaturedAppRight_CreateActivityMarkerResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - beneficiaries - \[`AppRewardBeneficiary `_\] - The set of beneficiaries and weights that define how the rewards should be split up between the beneficiary parties\. Implementations SHOULD check that the weights are positive and add up to 1\.0\. Implementations MAY also impose a limit on the maximum number of beneficiaries\. + **Method featuredAppRight\_CreateActivityMarkerImpl \:** `ContractId `_ `FeaturedAppRight `_ \-\> `FeaturedAppRight_CreateActivityMarker `_ \-\> `Update `_ `FeaturedAppRight_CreateActivityMarkerResult `_ Data Types ---------- .. _type-splice-api-featuredapprightv1-apprewardbeneficiary-32645: **data** `AppRewardBeneficiary `_ Specification of a beneficiary of featured app rewards\. .. _constr-splice-api-featuredapprightv1-apprewardbeneficiary-16584: `AppRewardBeneficiary `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - beneficiary - `Party `_ - The party that is granted the right to mint the weighted amount of reward for this activity\. * - weight - `Decimal `_ - A weight between 0\.0 and 1\.0 that defines how much of the reward this beneficiary can mint\. **instance** `Eq `_ `AppRewardBeneficiary `_ **instance** `Ord `_ `AppRewardBeneficiary `_ **instance** `Show `_ `AppRewardBeneficiary `_ **instance** `GetField `_ \"beneficiaries\" `FeaturedAppRight_CreateActivityMarker `_ \[`AppRewardBeneficiary `_\] **instance** `GetField `_ \"beneficiary\" `AppRewardBeneficiary `_ `Party `_ **instance** `GetField `_ \"weight\" `AppRewardBeneficiary `_ `Decimal `_ **instance** `SetField `_ \"beneficiaries\" `FeaturedAppRight_CreateActivityMarker `_ \[`AppRewardBeneficiary `_\] **instance** `SetField `_ \"beneficiary\" `AppRewardBeneficiary `_ `Party `_ **instance** `SetField `_ \"weight\" `AppRewardBeneficiary `_ `Decimal `_ .. _type-splice-api-featuredapprightv1-featuredappactivitymarkerview-84352: **data** `FeaturedAppActivityMarkerView `_ .. _constr-splice-api-featuredapprightv1-featuredappactivitymarkerview-55819: `FeaturedAppActivityMarkerView `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - dso - `Party `_ - The DSO party\. * - provider - `Party `_ - The featured app provider\. * - beneficiary - `Party `_ - The party that is granted the right to mint the weighted amount of reward for this activity\. * - weight - `Decimal `_ - A weight between 0\.0 and 1\.0 that defines how much of the reward this beneficiary can mint\. **instance** `Eq `_ `FeaturedAppActivityMarkerView `_ **instance** `Show `_ `FeaturedAppActivityMarkerView `_ **instance** `HasFromAnyView `_ `FeaturedAppActivityMarker `_ `FeaturedAppActivityMarkerView `_ **instance** `HasInterfaceView `_ `FeaturedAppActivityMarker `_ `FeaturedAppActivityMarkerView `_ **instance** `GetField `_ \"beneficiary\" `FeaturedAppActivityMarkerView `_ `Party `_ **instance** `GetField `_ \"dso\" `FeaturedAppActivityMarkerView `_ `Party `_ **instance** `GetField `_ \"provider\" `FeaturedAppActivityMarkerView `_ `Party `_ **instance** `GetField `_ \"weight\" `FeaturedAppActivityMarkerView `_ `Decimal `_ **instance** `SetField `_ \"beneficiary\" `FeaturedAppActivityMarkerView `_ `Party `_ **instance** `SetField `_ \"dso\" `FeaturedAppActivityMarkerView `_ `Party `_ **instance** `SetField `_ \"provider\" `FeaturedAppActivityMarkerView `_ `Party `_ **instance** `SetField `_ \"weight\" `FeaturedAppActivityMarkerView `_ `Decimal `_ .. _type-splice-api-featuredapprightv1-featuredapprightview-50078: **data** `FeaturedAppRightView `_ .. _constr-splice-api-featuredapprightv1-featuredapprightview-35459: `FeaturedAppRightView `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - dso - `Party `_ - The DSO party\. * - provider - `Party `_ - The featured app provider\. **instance** `Eq `_ `FeaturedAppRightView `_ **instance** `Show `_ `FeaturedAppRightView `_ **instance** `HasFromAnyView `_ `FeaturedAppRight `_ `FeaturedAppRightView `_ **instance** `HasInterfaceView `_ `FeaturedAppRight `_ `FeaturedAppRightView `_ **instance** `GetField `_ \"dso\" `FeaturedAppRightView `_ `Party `_ **instance** `GetField `_ \"provider\" `FeaturedAppRightView `_ `Party `_ **instance** `SetField `_ \"dso\" `FeaturedAppRightView `_ `Party `_ **instance** `SetField `_ \"provider\" `FeaturedAppRightView `_ `Party `_ .. _type-splice-api-featuredapprightv1-featuredapprightcreateactivitymarkerresult-54383: **data** `FeaturedAppRight_CreateActivityMarkerResult `_ Result of calling the ``FeaturedAppRight_CreateActivityMarker`` choice\. .. _constr-splice-api-featuredapprightv1-featuredapprightcreateactivitymarkerresult-43104: `FeaturedAppRight_CreateActivityMarkerResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - activityMarkerCids - \[`ContractId `_ `FeaturedAppActivityMarker `_\] - The set of activity markers created by the choice\. **instance** HasMethod `FeaturedAppRight `_ \"featuredAppRight\_CreateActivityMarkerImpl\" (`ContractId `_ `FeaturedAppRight `_ \-\> `FeaturedAppRight_CreateActivityMarker `_ \-\> `Update `_ `FeaturedAppRight_CreateActivityMarkerResult `_) **instance** `GetField `_ \"activityMarkerCids\" `FeaturedAppRight_CreateActivityMarkerResult `_ \[`ContractId `_ `FeaturedAppActivityMarker `_\] **instance** `SetField `_ \"activityMarkerCids\" `FeaturedAppRight_CreateActivityMarkerResult `_ \[`ContractId `_ `FeaturedAppActivityMarker `_\] **instance** `HasExercise `_ `FeaturedAppRight `_ `FeaturedAppRight_CreateActivityMarker `_ `FeaturedAppRight_CreateActivityMarkerResult `_ **instance** `HasExerciseGuarded `_ `FeaturedAppRight `_ `FeaturedAppRight_CreateActivityMarker `_ `FeaturedAppRight_CreateActivityMarkerResult `_ **instance** `HasFromAnyChoice `_ `FeaturedAppRight `_ `FeaturedAppRight_CreateActivityMarker `_ `FeaturedAppRight_CreateActivityMarkerResult `_ **instance** `HasToAnyChoice `_ `FeaturedAppRight `_ `FeaturedAppRight_CreateActivityMarker `_ `FeaturedAppRight_CreateActivityMarkerResult `_ Functions --------- .. _function-splice-api-featuredapprightv1-featuredapprightcreateactivitymarkerimpl-71588: `featuredAppRight_CreateActivityMarkerImpl `_ \: `FeaturedAppRight `_ \-\> `ContractId `_ `FeaturedAppRight `_ \-\> `FeaturedAppRight_CreateActivityMarker `_ \-\> `Update `_ `FeaturedAppRight_CreateActivityMarkerResult `_