2022 June Release

Actions of COOATTREDIT@1.1:AppPackage Permanent link for this heading

Return Type

Signature

void

AttrAppConfiguredAppsGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

void

AttrEmailLogoGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

boolean

CanShowOrgMembershipInfos(
  optional Group cloudorganization,
  optional object context,
  optional AttributeDefinition attrdef,
  optional boolean updatevalues,
  out retval boolean allowed)

boolean

CheckShopMenu(
  optional boolean usedistributionbundle,
  out retval boolean displaymenu)

DistributionBundle[]

GetAllowedDistributionBundles(
  optional SubscriptionInterval interval,
  optional CurrencySymbol currsymbol,
  out retval DistributionBundle[] allowedbundles)

string

GetAppNameSuffix(
  boolean usecomponentalternative,
  optional boolean includeclass,
  optional boolean skipapp,
  optional boolean includeroom,
  out retval string suffix)

object

GetBasePackage(
  out retval object package)

AppPackage

GetBundlePurchaseBaseEdition(
  optional boolean requiretrialversion,
  optional SubscriptionInterval interval,
  optional CurrencySymbol currsymbol,
  optional Subscription subscription,
  out retval AppPackage package)

AppPackage[]

GetContextSpecificEdition(
  out retval AppPackage[] contextspecificeditions)

string

GetEditionPurchaseName(
  boolean requireuppercase,
  out retval string purchasename)

AppPackage

GetFullEdition(
  out retval AppPackage edition)

PackageAppList[]

GetPackageApps(
  out retval PackageAppList[] apps,
  out ActivatedPackageApps[] activatedconfiguredgapps,
  out App[] configuredapps)

AppPackage[]

GetReadEdition(
  out retval AppPackage[] editions)

object

GetRootPackage(
  out retval object package)

string

GetServicePackagesDescription(
  out string title,
  out retval string descr)

boolean

IsBundelPurchasePossible(
  optional SubscriptionInterval interval,
  optional CurrencySymbol currsymbol,
  out retval boolean ispurchasepossible)

boolean

IsPackagePurchasedBy(
  object paymentowner,
  object benefitrecipient,
  boolean targetisuser,
  out Subscription subscr,
  out retval boolean purchased)

boolean

IsPackageUsableFor(
  out retval boolean memberassignment,
  out boolean contextassignment)

void

OpenPurchaseDistributionBundle(
  optional integer unused1,
  optional integer unused2)

void

OpenShop(
  optional integer unused1,
  optional integer unused2)

void

UnassignAppFromUser(
  optional integer unused1,
  optional integer unused2)


COOATTREDIT@1.1:AttrAppConfiguredAppsGet Permanent link for this heading

Calculate the list of configured apps in the app package

void COOATTREDIT@1.1:AttrAppConfiguredAppsGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


COODESK@1.1:AttrEmailLogoGet Permanent link for this heading

Get action to cache organization logo if it is not already cached, and is an svg image. Logo gets returned.

void COODESK@1.1:AttrEmailLogoGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


FSCFOLIOCLOUD@1.1001:CanShowOrgMembershipInfos Permanent link for this heading

Check if detailed informations about the cloud organization membership can be displayed

boolean FSCFOLIOCLOUD@1.1001:CanShowOrgMembershipInfos(
  optional Group cloudorganization,
  optional object context,
  optional AttributeDefinition attrdef,
  optional boolean updatevalues,
  out retval boolean allowed)

Name

Description

cloudorganization

the cloudorganization

context

attrdef

the attribute definition for which the values should be shown

updatevalues

the user can update the values saved in this property

allowed

informations can be displayed

Additional Information


FSCFOLIOCLOUDPAYMENT@1.1001:CheckShopMenu Permanent link for this heading

Action to decide if the shop menu should be displayed

boolean FSCFOLIOCLOUDPAYMENT@1.1001:CheckShopMenu(
  optional boolean usedistributionbundle,
  out retval boolean displaymenu)

Name

Description

usedistributionbundle

if set to true a distribution bundle purchase is requested

displaymenu

the result

Additional Information


FSCFOLIOPAYMENT@1.1001:GetAllowedDistributionBundles Permanent link for this heading

Get the allowed distribution packages for a bundle purchase of an edition

DistributionBundle[] FSCFOLIOPAYMENT@1.1001:GetAllowedDistributionBundles(
  optional SubscriptionInterval interval,
  optional CurrencySymbol currsymbol,
  out retval DistributionBundle[] allowedbundles)

Name

Description

interval

the subscription interval for which the purchase is requested

currsymbol

the currency used for the purchase

allowedbundles

the available bundles

Additional Information


FSCTEAMROOM@1.1001:GetAppNameSuffix Permanent link for this heading

string FSCTEAMROOM@1.1001:GetAppNameSuffix(
  boolean usecomponentalternative,
  optional boolean includeclass,
  optional boolean skipapp,
  optional boolean includeroom,
  out retval string suffix)

Name

Description

usecomponentalternative

includeclass

skipapp

includeroom

suffix

Additional Information


COOATTREDIT@1.1:GetBasePackage Permanent link for this heading

object COOATTREDIT@1.1:GetBasePackage(
  out retval object package)

Name

Description

package

Additional Information


FSCFOLIOPAYMENT@1.1001:GetBundlePurchaseBaseEdition Permanent link for this heading

Action the get the base edition for a bundle purchase

AppPackage FSCFOLIOPAYMENT@1.1001:GetBundlePurchaseBaseEdition(
  optional boolean requiretrialversion,
  optional SubscriptionInterval interval,
  optional CurrencySymbol currsymbol,
  optional Subscription subscription,
  out retval AppPackage package)

Name

Description

requiretrialversion

the purchase is only possible the benefit recipient is in trial mode

interval

the subscription interval for which the purchase is requested

currsymbol

the currency used for the purchase

subscription

the edtion should be taken from a specified subscription if the organization has no licensed edition

package

the edition

Additional Information


COOATTREDIT@1.1:GetContextSpecificEdition Permanent link for this heading

Retrieve the available context specific editions

AppPackage[] COOATTREDIT@1.1:GetContextSpecificEdition(
  out retval AppPackage[] contextspecificeditions)

Name

Description

contextspecificeditions

Additional Information


FSCFOLIOPAYMENT@1.1001:GetEditionPurchaseName Permanent link for this heading

Get the purchase name of an edition

string FSCFOLIOPAYMENT@1.1001:GetEditionPurchaseName(
  boolean requireuppercase,
  out retval string purchasename)

Name

Description

requireuppercase

purchasename

the purchase name

Additional Information


COOATTREDIT@1.1:GetFullEdition Permanent link for this heading

Retrieve the available full editions

AppPackage COOATTREDIT@1.1:GetFullEdition(
  out retval AppPackage edition)

Name

Description

edition

the full edition

Additional Information


COOATTREDIT@1.1:GetPackageApps Permanent link for this heading

Get the apps included in the packages

PackageAppList[] COOATTREDIT@1.1:GetPackageApps(
  out retval PackageAppList[] apps,
  out ActivatedPackageApps[] activatedconfiguredgapps,
  out App[] configuredapps)

Name

Description

apps

the included apps

activatedconfiguredgapps

the activated configured apps

configuredapps

the included configured apps

Additional Information


COOATTREDIT@1.1:GetReadEdition Permanent link for this heading

Retrieve the available read editions

AppPackage[] COOATTREDIT@1.1:GetReadEdition(
  out retval AppPackage[] editions)

Name

Description

editions

retrieve the available read edition

Additional Information


COOATTREDIT@1.1:GetRootPackage Permanent link for this heading

Get root package

object COOATTREDIT@1.1:GetRootPackage(
  out retval object package)

Name

Description

package

Additional Information


FSCVENVUI@1.1001:GetServicePackagesDescription Permanent link for this heading

Get a formatted description for the service packages

string FSCVENVUI@1.1001:GetServicePackagesDescription(
  out string title,
  out retval string descr)

Name

Description

title

the formatted name of the service package

descr

the formatted description of the service package

Additional Information


FSCFOLIOPAYMENT@1.1001:IsBundelPurchasePossible Permanent link for this heading

Action to define if the bundle purchase is possbile for a specific app package

boolean FSCFOLIOPAYMENT@1.1001:IsBundelPurchasePossible(
  optional SubscriptionInterval interval,
  optional CurrencySymbol currsymbol,
  out retval boolean ispurchasepossible)

Name

Description

interval

the subscription interval for which the purchase is requested

currsymbol

the currency used for the purchase

ispurchasepossible

the result

Additional Information


FSCFOLIOPAYMENT@1.1001:IsPackagePurchasedBy Permanent link for this heading

Checks if a certain package or higher package is purchased by a defined user for an user or group

boolean FSCFOLIOPAYMENT@1.1001:IsPackagePurchasedBy(
  object paymentowner,
  object benefitrecipient,
  boolean targetisuser,
  out Subscription subscr,
  out retval boolean purchased)

Name

Description

paymentowner

the owner of the already performed purchases (owner of paymentmodalities)

benefitrecipient

the user or group for whom the package has been purchased

targetisuser

the purchase is for an user

subscr

the purchasing subscription

purchased

the return value if the package or a higher package has been purchased

Additional Information


COOATTREDIT@1.1:IsPackageUsableFor Permanent link for this heading

Check if the edition can be use for members or for context specific license assignment

boolean COOATTREDIT@1.1:IsPackageUsableFor(
  out retval boolean memberassignment,
  out boolean contextassignment)

Name

Description

memberassignment

the package is usable for members of the group

contextassignment

the package is usable for

Additional Information


FSCFOLIOCLOUDPAYMENT@1.1001:OpenPurchaseDistributionBundle Permanent link for this heading

Usecase to open the cloud shop

void FSCFOLIOCLOUDPAYMENT@1.1001:OpenPurchaseDistributionBundle(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCFOLIOCLOUDPAYMENT@1.1001:OpenShop Permanent link for this heading

Usecase to open the cloud shop

void FSCFOLIOCLOUDPAYMENT@1.1001:OpenShop(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCFOLIOCLOUD@1.1001:UnassignAppFromUser Permanent link for this heading

Menu to manually unassign an app/edition from users

void FSCFOLIOCLOUD@1.1001:UnassignAppFromUser(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information