2022 June Release

Actions of FSCVENVUI@1.1001 Permanent link for this heading

Return Type

Signature

void

AddObjectToPortal(
  optional integer unused1,
  optional integer unused2)

void

CacheContent(
  string contobj,
  object attrdef,
  integer contid,
  Content cont,
  boolean setisdirty,
  boolean silent)

void

ClearCachedContent(
  string contobj,
  object attrdef,
  integer contid,
  boolean silent,
  optional boolean sametx)

void

ConfirmOAuthApp(
  WebServiceDefinition[] wsdefs,
  OAuthClient client,
  string code,
  string state)

void

ConfirmRenewServiceToken(
  optional integer venv_key)

void

CreateServiceToken()

void

EditObjectLogo(
  optional integer unused1,
  optional integer unused2)

void

EditObjectLogoSelected(
  optional integer unused1,
  optional integer unused2)

void

EditServiceToken(
  integer venv_key)

void

EmptyWastebasketApp(
  object wb,
  boolean donotask)

dictionary[]

EvaluateCPMindbreezeFacetDefinitions(
  ObjectClass objclass,
  optional ObjectClass roomclass,
  out retval dictionary[] facetdefinitiondicts)

MindbreezeFacetProp[]

EvaluateCPMindbreezeFacetPropsDefinitions(
  ObjectClass objclass,
  optional ObjectClass roomclass,
  out retval MindbreezeFacetProp[] facetprops)

MindbreezeFacetPropValues

EvaluateCPMindbreezeFacetPropValuesDefinitions(
  AttributeDefinition attrdef,
  ObjectClass objclass,
  optional ObjectClass roomclass,
  out retval MindbreezeFacetPropValues facetpropvalues)

dictionary[]

EvaluateCPMindbreezePropBoosting(
  ObjectClass objclass,
  optional ObjectClass roomclass,
  out retval dictionary[] propboostingdicts)

dictionary[]

EvaluateCPMindbreezeQueryConstraints(
  ObjectClass objclass,
  optional ObjectClass roomclass,
  optional MindbreezeQueryConstraint constrainttype,
  out retval dictionary[] queryconstraintdicts)

void

ExportAuditLog(
  optional integer unused1,
  optional integer unused2)

void

ExportAuditLogSelected(
  optional integer unused1,
  optional integer unused2)

void

FilterSendMenus(
  optional integer unused1,
  optional integer unused2,
  ref MenuStructList[] menuentries,
  optional object menu,
  optional object[] selobjects,
  out optional boolean addchildren)

void

GetAdditionalConfigValues(
  out string[] keys,
  out string[] values)

any

GetAverageContSize(
  any values,
  out retval any result,
  out optional any simpleview,
  any attrdef)

string

GetBackgroundMenuHtmlPostWrapper(
  ref retval string headerhtml,
  ref string footerhtml,
  integer menucount,
  object attrdef)

object[]

GetBGImageSuggestions(
  out retval object[] suggestions)

Content

GetBrandingFallbackLogo(
  ref string logoname,
  out retval Content logo)

dictionary

GetBrandingLayout(
  LogoType logotype,
  optional object context,
  out retval dictionary headerlayout)

Content

GetBrandingLogo(
  integer logotype,
  optional object context,
  optional boolean nofallback,
  out retval Content logo,
  out datetime logochangedat,
  out string logoname,
  out string logoextension)

string

GetBrandingLogoURL(
  integer logotype,
  optional object context,
  out retval string url,
  optional object selfservicebranding,
  optional Language userlang,
  out string logohref,
  out string logoaltname)

string

GetBrandingLogoURLPostWrapper(
  integer logotype,
  optional object context,
  ref retval string url,
  optional object selfservicebranding,
  optional Language userlang,
  ref string logohref,
  ref string logoaltname)

Content

GetCachedContent(
  string contobj,
  object attrdef,
  integer contid,
  out retval Content cachedcont,
  out boolean isdirty)

AttributeDefinition

GetDefaultViewAttr(
  object obj,
  optional boolean strict,
  out retval AttributeDefinition attrdef)

string

GetInaccessibleObjectsFURL(
  string mailaddresses,
  string mailattachments,
  out retval string objects)

object[]

GetLogoSuggestions(
  ObjectClass cls,
  out retval object[] suggestions)

void

GetMenuExportAuditLog(
  optional integer unused1,
  optional integer unused2,
  ref MenuStructList[] menuentries,
  optional object menu,
  optional object[] selobjects,
  out optional boolean addchildren)

MindbreezeFacetProp[]

GetMindbreezeFacetProps(
  object obj,
  out retval MindbreezeFacetProp[] result)

MindbreezeFacetPropValues

GetMindbreezeFacetPropValues(
  object obj,
  AttributeDefinition[] attributes,
  out retval MindbreezeFacetPropValues result)

dictionary

GetMindbreezeQueryConstraintsImpl(
  object currobj,
  object constraintobj,
  string currsessionid,
  out retval dictionary queryconstraints)

string

GetMindbreezeQueryConstraintsRPC(
  string arguments,
  out retval string queryconstraints)

MobileTaskPaneMenu[]

GetMobileTaskPaneMenus(
  object containerobject,
  optional AttributeDefinition containerview,
  optional object selectedobject,
  optional Breadcrumb[] breadcrumb,
  out retval MobileTaskPaneMenu[] result,
  out any[] exceptions)

string

GetNativeClientConfigurationURL(
  out retval string nativeclientconfig)

dictionary

GetNativeClientConfigurationWS(
  optional object targetobj,
  out retval dictionary result)

TreeExpressionData[]

GetOpenFromToolExpressionData(
  ref retval TreeExpressionData[] treedata)

string

GetPathFURL(
  optional string theme,
  out retval string themepath)

string

GetServicePackagesDescription(
  out string title,
  out retval string descr)

string

GetServiceTokenFURL(
  string comment,
  object scope,
  ServiceTokenExpiration expiration,
  out retval string token)

any

GetSumContSize(
  any values,
  out retval any result,
  out optional any simpleview,
  any attrdef)

void

ImportOfficeDocument(
  object venv_object,
  optional ThirdPartyContextObject venv_tpco,
  optional ThirdPartyContextExternal venv_tpce,
  optional string venv_tag,
  optional string venv_cleanpoint,
  optional string venv_objname,
  optional integer venv_selcount,
  optional integer venv_attcount,
  optional integer venv_reccount,
  optional integer venv_bodyformat,
  optional boolean venv_donotclosewindow,
  optional string venv_docparam,
  optional string venv_contextinfo,
  optional string venv_reference,
  optional object venv_property,
  optional string venv_tablevar,
  optional string venv_dispname)

boolean

IsBreadcrumbObjectAllowedToSync(
  out retval boolean allowed)

boolean

IsBreadcrumbPathAllowedToSync(
  Breadcrumb[] breadcrumbs,
  out retval boolean allowed)

boolean

IsMailMergeActive(
  out retval boolean active)

boolean

IsMobileAgent(
  out retval boolean ismobile)

void

LoginCallback()

void

LogoutCallback()

void

MenuAppAccessGet(
  optional integer unused1,
  optional integer unused2,
  ref MenuStructList[] menuentries,
  optional object menu,
  optional object[] selobjects,
  out optional boolean addchildren)

void

MenuHelpGet(
  optional integer unused1,
  optional integer unused2,
  ref MenuStructList[] menuentries,
  optional object menu,
  optional object[] selobjects,
  out optional boolean addchildren)

void

OpenFromTool(
  object venv_object,
  string venv_objname,
  object venv_objclass,
  object venv_parent,
  object venv_view,
  string venv_filelocation,
  string venv_filenames)

void

OpenOfficeDocument(
  object venv_object,
  optional ThirdPartyContextObject venv_tpco,
  optional ThirdPartyContextExternal venv_tpce,
  optional string venv_tag,
  optional string venv_cleanpoint,
  optional string venv_objname,
  optional integer venv_selcount,
  optional integer venv_attcount,
  optional integer venv_reccount,
  optional integer venv_bodyformat,
  optional boolean venv_donotclosewindow,
  optional string venv_docparam,
  optional string venv_contextinfo,
  optional string venv_reference,
  optional object venv_property,
  optional string venv_tablevar,
  optional string venv_dispname)

void

Redirect2OAuthApp(
  OAuthClient client,
  string code,
  string state,
  boolean usesecclearance,
  boolean confirm)

void

RevokeServiceTokenFURL(
  string comment,
  object scope)

void

ScanAppConfirm(
  optional integer unused1,
  optional integer unused2)

void

ScanAppConfirmSelected(
  optional integer unused1,
  optional integer unused2)

void

SendAsPointerDirect(
  optional integer unused1,
  optional integer unused2)

void

SetCachedContentDirty(
  string contobj,
  object attrdef,
  integer contid,
  boolean setisdirty,
  boolean silent)

void

SettingsOverview(
  Prerequisite[] venv_prerequfailed,
  Prerequisite[] venv_prerequfailedopt,
  Prerequisite[] venv_prerequpassed)

void

ShowAppAccess(
  optional integer unused1,
  optional integer unused2)

void

ShowBrowserStatus(
  Prerequisite[] venv_prerequfailed,
  Prerequisite[] venv_prerequfailedopt,
  Prerequisite[] venv_prerequpassed,
  optional string venv_pagelabel)

void

ShowOfflineSync(
  optional integer unused1,
  optional integer unused2)

void

SynchronizeFolder(
  optional integer unused1,
  optional integer unused2)

void

TPAccessCheckGetMenuItems(
  ref RibbonControlStruct control)

void

TPAssignProperties(
  object[] objs,
  string[] names,
  string[] types)

void

TPAssignTextModule(
  boolean binary,
  string module,
  string content,
  optional string type,
  optional integer size,
  out optional string[] nestedmodules)

void

TPAttachBinary(
  string value,
  string extension,
  integer size,
  optional string name)

void

TPAttrChanged(
  optional object[] objects)

string

TPBeforeImport(
  boolean isselection,
  boolean isrecipient,
  boolean isattachment,
  integer idx,
  optional string propdeflist,
  out retval string result)

void

TPCheckSentPointerAccessApp(
  object venv_object,
  optional ThirdPartyContextObject venv_tpco,
  optional ThirdPartyContextExternal venv_tpce,
  optional string venv_tag,
  optional string venv_cleanpoint,
  optional string venv_objname,
  optional integer venv_selcount,
  optional integer venv_attcount,
  optional integer venv_reccount,
  optional integer venv_bodyformat,
  optional boolean venv_donotclosewindow,
  optional string venv_docparam,
  optional string venv_contextinfo,
  optional string venv_reference,
  optional object venv_property,
  optional string venv_tablevar,
  optional string venv_dispname)

void

TPCloseDocument()

void

TPConcludeImport(
  boolean isselection,
  boolean isrecipient,
  boolean isattachment,
  boolean remove)

void

TPCopyLinkApp(
  object venv_object,
  optional ThirdPartyContextObject venv_tpco,
  optional ThirdPartyContextExternal venv_tpce,
  optional string venv_tag,
  optional string venv_cleanpoint,
  optional string venv_objname,
  optional integer venv_selcount,
  optional integer venv_attcount,
  optional integer venv_reccount,
  optional integer venv_bodyformat,
  optional boolean venv_donotclosewindow,
  optional string venv_docparam,
  optional string venv_contextinfo,
  optional string venv_reference,
  optional object venv_property,
  optional string venv_tablevar,
  optional string venv_dispname)

void

TPDissolveTextModules(
  string[] topmodules)

void

TPDocumentTreeConnect(
  object targetobj,
  boolean isencrypted)

string

TPDocumentTreeCreate(
  boolean leaf,
  ref retval string keys,
  optional string displayname,
  optional ThirdPartyContextExport tpce,
  optional string messageclass)

string

TPDocumentTreeModify(
  boolean leaf,
  string keys,
  string vals,
  out retval string errors)

void

TPDocumentTreeRemove(
  boolean leaf,
  string keys)

string

TPGetEmailAdressForRecipients(
  integer venv_reccount,
  out retval string mails)

string

TPGetEmailAttachmentsPath(
  integer venv_attcount,
  out retval string path)

string

TPGetFormattedModules(
  optional integer fscope,
  out retval string objects)

string

TPGetLinkedObjects(
  out retval string objects)

string

TPGetObjectFromModuleTag(
  string module,
  out retval string objaddr,
  ref optional string cleanpointutc)

string

TPGetPlainModules(
  optional integer pscope,
  out retval string objects)

void

TPImportDocumentTrack(
  dictionary fileinfo)

void

TPInsertBinary(
  string bvalue,
  string bextension,
  integer bsize,
  optional string bobject,
  optional integer bscope,
  optional string bframetype,
  optional string bname,
  optional string bcleanpoint)

void

TPInsertFormatted(
  string fvalue,
  string fextension,
  optional string fobject,
  optional integer fscope,
  optional string fframetype)

void

TPInsertLinkFormatted(
  string davuri)

void

TPInsertLinkPlain(
  string docproperty)

void

TPInsertPlain(
  string pvalue,
  optional string pobject,
  optional integer pscope,
  optional string pframetype,
  optional string pname,
  optional string pcleanpoint)

void

TPInsertShape(
  optional string uri,
  optional integer shapetype,
  optional integer shapewidth,
  optional integer shapeheight)

boolean

TPIsDocumentClean(
  out retval boolean clean)

void

TPModifyProperties(
  boolean isselection,
  boolean isrecipient,
  boolean isattachment,
  string json,
  integer idx)

void

TPNestedModules(
  string[] modules,
  out string[] nestedmodules)

string

TPPrepareImport(
  boolean isattachment,
  boolean isselection,
  optional string param,
  out retval string filepath)

void

TPPropertiesApp(
  object venv_object,
  optional ThirdPartyContextObject venv_tpco,
  optional ThirdPartyContextExternal venv_tpce,
  optional string venv_tag,
  optional string venv_cleanpoint,
  optional string venv_objname,
  optional integer venv_selcount,
  optional integer venv_attcount,
  optional integer venv_reccount,
  optional integer venv_bodyformat,
  optional boolean venv_donotclosewindow,
  optional string venv_docparam,
  optional string venv_contextinfo,
  optional string venv_reference,
  optional object venv_property,
  optional string venv_tablevar,
  optional string venv_dispname)

void

TPProtectableTextModules(
  out string[] allobjs)

void

TPPublicLinkApp(
  object venv_object,
  optional ThirdPartyContextObject venv_tpco,
  optional ThirdPartyContextExternal venv_tpce,
  optional string venv_tag,
  optional string venv_cleanpoint,
  optional string venv_objname,
  optional integer venv_selcount,
  optional integer venv_attcount,
  optional integer venv_reccount,
  optional integer venv_bodyformat,
  optional boolean venv_donotclosewindow,
  optional string venv_docparam,
  optional string venv_contextinfo,
  optional string venv_reference,
  optional object venv_property,
  optional string venv_tablevar,
  optional string venv_dispname)

void

TPRemoveTextModules(
  string[] modules)

void

TPRenameApp(
  object venv_object,
  optional ThirdPartyContextObject venv_tpco,
  optional ThirdPartyContextExternal venv_tpce,
  optional string venv_tag,
  optional string venv_cleanpoint,
  optional string venv_objname,
  optional integer venv_selcount,
  optional integer venv_attcount,
  optional integer venv_reccount,
  optional integer venv_bodyformat,
  optional boolean venv_donotclosewindow,
  optional string venv_docparam,
  optional string venv_contextinfo,
  optional string venv_reference,
  optional object venv_property,
  optional string venv_tablevar,
  optional string venv_dispname)

void

TPSaveDocument()

void

TPSendLinkApp(
  object venv_object,
  optional ThirdPartyContextObject venv_tpco,
  optional ThirdPartyContextExternal venv_tpce,
  optional string venv_tag,
  optional string venv_cleanpoint,
  optional string venv_objname,
  optional integer venv_selcount,
  optional integer venv_attcount,
  optional integer venv_reccount,
  optional integer venv_bodyformat,
  optional boolean venv_donotclosewindow,
  optional string venv_docparam,
  optional string venv_contextinfo,
  optional string venv_reference,
  optional object venv_property,
  optional string venv_tablevar,
  optional string venv_dispname)

void

TPSetCleanpointAtTag(
  string cleanpointutc,
  ref string module)

void

TPSetDocumentClean(
  boolean clean)

void

TPSetDocumentCleanPoint(
  optional datetime cleanpoint)

void

TPSetProtectionType(
  ThirdPartyContentProtection protection,
  ref string module)

ThirdPartyContentProtection[]

TPTextModuleProtectionGet(
  object[] modules,
  out retval ThirdPartyContentProtection[] protections)

void

TPTopTextModules(
  integer scope,
  integer condition,
  out string[] topmodules)

void

TPTouchTextModule(
  string module,
  string name)

void

TPUpdateDocProperties(
  optional dictionary entries)

void

TPUpdateExternalRibbon(
  RibbonControlSite rcsite)

void

TPUpdateFields(
  optional dictionary entries)

void

TPUpdateObjectRibbon(
  RibbonControlSite rcsite)


FSCVENVUI@1.1001:AddObjectToPortal Permanent link for this heading

add object to the favorites portal

void FSCVENVUI@1.1001:AddObjectToPortal(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVENVUI@1.1001:CacheContent Permanent link for this heading

This action can be used to cache contents in the control content cache

void FSCVENVUI@1.1001:CacheContent(
  string contobj,
  object attrdef,
  integer contid,
  Content cont,
  boolean setisdirty,
  boolean silent)

Name

Description

contobj

The content object.

attrdef

Content attribute definition.

contid

Content id.

cont

setisdirty

Mark the content as dirty.

silent

all error will be swallowed silently

Additional Information


FSCVENVUI@1.1001:ClearCachedContent Permanent link for this heading

This action can be used to clear cached contents from the control content cache

void FSCVENVUI@1.1001:ClearCachedContent(
  string contobj,
  object attrdef,
  integer contid,
  boolean silent,
  optional boolean sametx)

Name

Description

contobj

The content object.

attrdef

Content attribute definition.

contid

Content id.

silent

all error will be swallowed silently

sametx

the content cache will be cleared in the current transaction

Additional Information


FSCVENVUI@1.1001:ConfirmOAuthApp Permanent link for this heading

void FSCVENVUI@1.1001:ConfirmOAuthApp(
  WebServiceDefinition[] wsdefs,
  OAuthClient client,
  string code,
  string state)

Name

Description

wsdefs

client

code

state

Additional Information


FSCVENVUI@1.1001:ConfirmRenewServiceToken Permanent link for this heading

void FSCVENVUI@1.1001:ConfirmRenewServiceToken(
  optional integer venv_key)

Name

Description

venv_key

Additional Information


FSCVENVUI@1.1001:CreateServiceToken Permanent link for this heading

void FSCVENVUI@1.1001:CreateServiceToken()

Additional Information


FSCVENVUI@1.1001:EditObjectLogo Permanent link for this heading

define the logo for an object

void FSCVENVUI@1.1001:EditObjectLogo(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVENVUI@1.1001:EditObjectLogoSelected Permanent link for this heading

void FSCVENVUI@1.1001:EditObjectLogoSelected(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVENVUI@1.1001:EditServiceToken Permanent link for this heading

void FSCVENVUI@1.1001:EditServiceToken(
  integer venv_key)

Name

Description

venv_key

Additional Information


FSCVENVUI@1.1001:EmptyWastebasketApp Permanent link for this heading

This application can be used to empty a wastebasket

void FSCVENVUI@1.1001:EmptyWastebasketApp(
  object wb,
  boolean donotask)

Name

Description

wb

The wastebasket object.

donotask

Do not ask for object deletion.

Additional Information


FSCVENVUI@1.1001:EvaluateCPMindbreezeFacetDefinitions Permanent link for this heading

Evaluates the customization point CPMindbreezeFacetDefinitions.
Specialized evaluation is necessary because CPMindbreezeFacetDefinitions has optional keys, which may be null. The default customization point evaluation does not care about null values, this evaluation takes null values into account.

dictionary[] FSCVENVUI@1.1001:EvaluateCPMindbreezeFacetDefinitions(
  ObjectClass objclass,
  optional ObjectClass roomclass,
  out retval dictionary[] facetdefinitiondicts)

Name

Description

objclass

See parameter objclass of CPMindbreezeFacetDefinitions.

roomclass

See parameter roomclass of CPMindbreezeFacetDefinitions.

facetdefinitiondicts

See parameter facetdefinitiondicts of CPMindbreezeFacetDefinitions.

Additional Information


FSCVENVUI@1.1001:EvaluateCPMindbreezeFacetPropsDefinitions Permanent link for this heading

Evaluates the customization point CPMindbreezeFacetPropsDefinitions.
Specialized evaluation is necessary because CPMindbreezeFacetPropsDefinitions has optional keys, which may be null. The default customization point evaluation does not care about null values, this evaluation takes null values into account.

MindbreezeFacetProp[] FSCVENVUI@1.1001:EvaluateCPMindbreezeFacetPropsDefinitions(
  ObjectClass objclass,
  optional ObjectClass roomclass,
  out retval MindbreezeFacetProp[] facetprops)

Name

Description

objclass

See parameter objclass of CPMindbreezeFacetPropsDefinitions.

roomclass

See parameter roomclass of CPMindbreezeFacetPropsDefinitions.

facetprops

See parameter facetprops of CPMindbreezeFacetPropsDefinitions.

Additional Information


FSCVENVUI@1.1001:EvaluateCPMindbreezeFacetPropValuesDefinitions Permanent link for this heading

Evaluates the customization point CPMindbreezeFacetPropValuesDefinitions.
Specialized evaluation is necessary because CPMindbreezeFacetPropValuesDefinitions has optional keys, which may be null. The default customization point evaluation does not care about null values, this evaluation takes null values into account.

MindbreezeFacetPropValues FSCVENVUI@1.1001:EvaluateCPMindbreezeFacetPropValuesDefinitions(
  AttributeDefinition attrdef,
  ObjectClass objclass,
  optional ObjectClass roomclass,
  out retval MindbreezeFacetPropValues facetpropvalues)

Name

Description

attrdef

See parameter attrdef of CPMindbreezeFacetPropValuesDefinitions.

objclass

See parameter objclass of CPMindbreezeFacetPropValuesDefinitions.

roomclass

See parameter roomclass of CPMindbreezeFacetPropValuesDefinitions.

facetpropvalues

See parameter facetpropvalues of CPMindbreezeFacetPropValuesDefinitions.

Additional Information


FSCVENVUI@1.1001:EvaluateCPMindbreezePropBoosting Permanent link for this heading

Evaluates the customization point CPMindbreezePropBoosting.
Specialized evaluation is necessary because CPMindbreezePropBoosting has optional keys, which may be null. The default customization point evaluation does not care about null values, this evaluation takes null values into account.

dictionary[] FSCVENVUI@1.1001:EvaluateCPMindbreezePropBoosting(
  ObjectClass objclass,
  optional ObjectClass roomclass,
  out retval dictionary[] propboostingdicts)

Name

Description

objclass

See parameter objclass of CPMindbreezePropBoosting.

roomclass

See parameter roomclass of CPMindbreezePropBoosting.

propboostingdicts

See parameter propboostingdicts of CPMindbreezePropBoosting.

Additional Information


FSCVENVUI@1.1001:EvaluateCPMindbreezeQueryConstraints Permanent link for this heading

Evaluates the customization point CPMindbreezeQueryConstraints.
Specialized evaluation is necessary because CPMindbreezeQueryConstraints has optional keys, which may be null. The default customization point evaluation does not care about null values, this evaluation takes null values into account.

dictionary[] FSCVENVUI@1.1001:EvaluateCPMindbreezeQueryConstraints(
  ObjectClass objclass,
  optional ObjectClass roomclass,
  optional MindbreezeQueryConstraint constrainttype,
  out retval dictionary[] queryconstraintdicts)

Name

Description

objclass

See parameter objclass of CPMindbreezeQueryConstraints.

roomclass

See parameter roomclass of CPMindbreezeQueryConstraints.

constrainttype

See parameter constrainttype of CPMindbreezeQueryConstraints.

queryconstraintdicts

See parameter queryconstraintdicts of CPMindbreezeQueryConstraints.

Additional Information


FSCVENVUI@1.1001:ExportAuditLog Permanent link for this heading

void FSCVENVUI@1.1001:ExportAuditLog(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVENVUI@1.1001:ExportAuditLogSelected Permanent link for this heading

void FSCVENVUI@1.1001:ExportAuditLogSelected(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVENVUI@1.1001:FilterSendMenus Permanent link for this heading

void FSCVENVUI@1.1001:FilterSendMenus(
  optional integer unused1,
  optional integer unused2,
  ref MenuStructList[] menuentries,
  optional object menu,
  optional object[] selobjects,
  out optional boolean addchildren)

Name

Description

unused1

unused2

menuentries

menu

selobjects

addchildren

Additional Information


FSCVENVUI@1.1001:GetAdditionalConfigValues Permanent link for this heading

Returns additional configvalues that are written to the local registry

void FSCVENVUI@1.1001:GetAdditionalConfigValues(
  out string[] keys,
  out string[] values)

Name

Description

keys

list of keys, name of string value in registry

values

list of the values to the keys, each key must have its value

Additional Information


FSCVENVUI@1.1001:GetAverageContSize Permanent link for this heading

Calculates the average of a list of content size values and adds a " KB" suffix.

any FSCVENVUI@1.1001:GetAverageContSize(
  any values,
  out retval any result,
  out optional any simpleview,
  any attrdef)

Name

Description

values

result

simpleview

attrdef

Additional Information


FSCVENVUI@1.1001:GetBackgroundMenuHtmlPostWrapper Permanent link for this heading

string FSCVENVUI@1.1001:GetBackgroundMenuHtmlPostWrapper(
  ref retval string headerhtml,
  ref string footerhtml,
  integer menucount,
  object attrdef)

Name

Description

headerhtml

footerhtml

menucount

attrdef

Additional Information


FSCVENVUI@1.1001:GetBGImageSuggestions Permanent link for this heading

Calculates the background image suggestions for the object

object[] FSCVENVUI@1.1001:GetBGImageSuggestions(
  out retval object[] suggestions)

Name

Description

suggestions

the background image suggestions

Additional Information


FSCVENVUI@1.1001:GetBrandingFallbackLogo Permanent link for this heading

Get a fallback logo

Content FSCVENVUI@1.1001:GetBrandingFallbackLogo(
  ref string logoname,
  out retval Content logo)

Name

Description

logoname

Logo name

logo

Logo content

Additional Information


FSCVENVUI@1.1001:GetBrandingLayout Permanent link for this heading

Get branding layout

dictionary FSCVENVUI@1.1001:GetBrandingLayout(
  LogoType logotype,
  optional object context,
  out retval dictionary headerlayout)

Name

Description

logotype

Logo type (LogoType

context

Context object

headerlayout

Layout dictionary

Additional Information


FSCVENVUI@1.1001:GetBrandingLogo Permanent link for this heading

Get branding logo content

Content FSCVENVUI@1.1001:GetBrandingLogo(
  integer logotype,
  optional object context,
  optional boolean nofallback,
  out retval Content logo,
  out datetime logochangedat,
  out string logoname,
  out string logoextension)

Name

Description

logotype

Logo type (LogoType resp. FSCFOLIOCLOUD@1.1001:BrandingLogoType temporarily used by the private cloud IDP)

context

Context object

nofallback

logo

Logo content

logochangedat

logoname

logoextension

Additional Information


FSCVENVUI@1.1001:GetBrandingLogoURL Permanent link for this heading

Get URL to branding logo

string FSCVENVUI@1.1001:GetBrandingLogoURL(
  integer logotype,
  optional object context,
  out retval string url,
  optional object selfservicebranding,
  optional Language userlang,
  out string logohref,
  out string logoaltname)

Name

Description

logotype

(LogoType resp. FSCFOLIOCLOUD@1.1001:BrandingLogoType temporarily used by the private cloud IDP)

context

Context object

url

URL to logo

selfservicebranding

userlang

logohref

logoaltname

Additional Information


FSCVENVUI@1.1001:GetBrandingLogoURLPostWrapper Permanent link for this heading

string FSCVENVUI@1.1001:GetBrandingLogoURLPostWrapper(
  integer logotype,
  optional object context,
  ref retval string url,
  optional object selfservicebranding,
  optional Language userlang,
  ref string logohref,
  ref string logoaltname)

Name

Description

logotype

context

url

selfservicebranding

userlang

logohref

logoaltname

Additional Information


FSCVENVUI@1.1001:GetCachedContent Permanent link for this heading

This action can be used to get a content out of the control content cache

Content FSCVENVUI@1.1001:GetCachedContent(
  string contobj,
  object attrdef,
  integer contid,
  out retval Content cachedcont,
  out boolean isdirty)

Name

Description

contobj

The content object.

attrdef

Content attribute definition.

contid

Content id.

cachedcont

The cached content.

isdirty

Content dirty flag.

Additional Information


FSCVENVUI@1.1001:GetDefaultViewAttr Permanent link for this heading

Use this method as helper to determine and build a selection context when no view is provided. It will return the default view attribute.
e.g.:
  • teamroom: trchildren
  • folder: objchildren
  • scrum project (without strict): prcurrentdefects
  • scrum project (with strict): throws an error

AttributeDefinition FSCVENVUI@1.1001:GetDefaultViewAttr(
  object obj,
  optional boolean strict,
  out retval AttributeDefinition attrdef)

Name

Description

obj

the object for which the default view attribute should be evaluated

strict

when true, an error is thrown when the object has more than 1 view attributes available

attrdef

this will be default view attribute of the object.

Additional Information


FSCVENVUI@1.1001:GetInaccessibleObjectsFURL Permanent link for this heading

Retrieve all inaccessible objects

string FSCVENVUI@1.1001:GetInaccessibleObjectsFURL(
  string mailaddresses,
  string mailattachments,
  out retval string objects)

Name

Description

mailaddresses

mailattachments

objects

Additional Information


FSCVENVUI@1.1001:GetLogoSuggestions Permanent link for this heading

object[] FSCVENVUI@1.1001:GetLogoSuggestions(
  ObjectClass cls,
  out retval object[] suggestions)

Name

Description

cls

suggestions

Additional Information


FSCVENVUI@1.1001:GetMenuExportAuditLog Permanent link for this heading

void FSCVENVUI@1.1001:GetMenuExportAuditLog(
  optional integer unused1,
  optional integer unused2,
  ref MenuStructList[] menuentries,
  optional object menu,
  optional object[] selobjects,
  out optional boolean addchildren)

Name

Description

unused1

unused2

menuentries

menu

selobjects

addchildren

Additional Information


FSCVENVUI@1.1001:GetMindbreezeFacetProps Permanent link for this heading

This usecase calculates the facet definitions to be used with mindbreeze clients.

MindbreezeFacetProp[] FSCVENVUI@1.1001:GetMindbreezeFacetProps(
  object obj,
  out retval MindbreezeFacetProp[] result)

Name

Description

obj

the object will be used to evaluate the defined facets.

result

a list of MindbreezeFacetProp with the defined facets.

Additional Information


FSCVENVUI@1.1001:GetMindbreezeFacetPropValues Permanent link for this heading

This usecase calculates the facet values to be used with mindbreeze clients.

MindbreezeFacetPropValues FSCVENVUI@1.1001:GetMindbreezeFacetPropValues(
  object obj,
  AttributeDefinition[] attributes,
  out retval MindbreezeFacetPropValues result)

Name

Description

obj

the object will be used to evaluate the defined facets.

attributes

each AttributeDefinition of the list will be used to evaluate the defined facets.

result

the result of type MindbreezeFacetPropValues contains a list of possible values and valid classes.

Additional Information


FSCVENVUI@1.1001:GetMindbreezeQueryConstraintsImpl Permanent link for this heading

This usecase calculates the mindbreeze query constraints.

dictionary FSCVENVUI@1.1001:GetMindbreezeQueryConstraintsImpl(
  object currobj,
  object constraintobj,
  string currsessionid,
  out retval dictionary queryconstraints)

Name

Description

currobj

the current object

constraintobj

the constraint object

currsessionid

the current session id

queryconstraints

the queryconstraints

Additional Information


FSCVENVUI@1.1001:GetMindbreezeQueryConstraintsRPC Permanent link for this heading

This usecase wraps the usecase GetMindbreezeQueryConstraintsImpl which calculates the mindbreeze query constraints. Client sides calls can only handle input strings an output strings and need a special ACL.

string FSCVENVUI@1.1001:GetMindbreezeQueryConstraintsRPC(
  string arguments,
  out retval string queryconstraints)

Name

Description

arguments

input string containing <current object address>|<constraint object address>

queryconstraints

the queryconstraints @see GetMindbreezeQueryConstraintsImpl

Additional Information


FSCVENVUI@1.1001:GetMobileTaskPaneMenus Permanent link for this heading

Retrieves all task pane menus which are available for mobile apps. The available menus are calculated by using GetTaskPaneMenuStructList.

MobileTaskPaneMenu[] FSCVENVUI@1.1001:GetMobileTaskPaneMenus(
  object containerobject,
  optional AttributeDefinition containerview,
  optional object selectedobject,
  optional Breadcrumb[] breadcrumb,
  out retval MobileTaskPaneMenu[] result,
  out any[] exceptions)

Name

Description

containerobject

The object (compound object) for which the menus are calculated,
or the parent of the selected object (content object) for which the menus are calculated.

containerview

The view (attribute definition) for which the menus are calculated,
or the parent view of the selected object (content object) for which the menus are calculated.
Optional: This parameter should only be set if menus for a specific attribute (list) are calculated.

selectedobject

The object (content object) for which the menus are calculated.
Optional: This parameter should only be set if menus for content objects (preview) are calculated.

breadcrumb

A list of breadcrumbs (Breadcrumb).
Optional: If this parameter is not set, GetBreadCrumb will be used to calculate the breadcrumb list.

result

The result containing a list of menus.

exceptions

A list of exceptions if some occurred. @see GetTaskPaneMenuStructList @see GetBreadCrumb

Additional Information


FSCVENVUI@1.1001:GetNativeClientConfigurationURL Permanent link for this heading

This application returns the initial native client configuration.

string FSCVENVUI@1.1001:GetNativeClientConfigurationURL(
  out retval string nativeclientconfig)

Name

Description

nativeclientconfig

Additional Information


FSCVENVUI@1.1001:GetNativeClientConfigurationWS Permanent link for this heading

dictionary FSCVENVUI@1.1001:GetNativeClientConfigurationWS(
  optional object targetobj,
  out retval dictionary result)

Name

Description

targetobj

result

Additional Information


FSCVENVUI@1.1001:GetOpenFromToolExpressionData Permanent link for this heading

This method retrieves the data for defining the expression to build the tree for Open From Office Buttons

TreeExpressionData[] FSCVENVUI@1.1001:GetOpenFromToolExpressionData(
  ref retval TreeExpressionData[] treedata)

Name

Description

treedata

the expression

Additional Information


FSCVENVUI@1.1001:GetPathFURL Permanent link for this heading

string FSCVENVUI@1.1001:GetPathFURL(
  optional string theme,
  out retval string themepath)

Name

Description

theme

themepath

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


FSCVENVUI@1.1001:GetServiceTokenFURL Permanent link for this heading

Create an access token for a particular service or application (see also passwords for applications). If there already exists a token with the same comment and scope, the token is revoked and created anew (i.e. the old token with that key is no longer valid).
Requires active configuration of SAML 2.0.

string FSCVENVUI@1.1001:GetServiceTokenFURL(
  string comment,
  object scope,
  ServiceTokenExpiration expiration,
  out retval string token)

Name

Description

comment

A string that helps the user to determine what the token was created for.

scope

A FSCOWS@1.1001:WebServiceDefiniton object this token is valid for. The token can only be used to call actions of this web service.

expiration

The expiration time for the token. The token has to be renewed by the user before.

token

The resulting token (password for application). You have to store this token in a safe place. @see FSCOWS@1.1001:usersetstaccess @see RevokeServiceTokenFURL

Additional Information


FSCVENVUI@1.1001:GetSumContSize Permanent link for this heading

Calculates the sum of a list of content size values and adds a " KB" suffix.

any FSCVENVUI@1.1001:GetSumContSize(
  any values,
  out retval any result,
  out optional any simpleview,
  any attrdef)

Name

Description

values

result

simpleview

attrdef

Additional Information


FSCVENVUI@1.1001:ImportOfficeDocument Permanent link for this heading

void FSCVENVUI@1.1001:ImportOfficeDocument(
  object venv_object,
  optional ThirdPartyContextObject venv_tpco,
  optional ThirdPartyContextExternal venv_tpce,
  optional string venv_tag,
  optional string venv_cleanpoint,
  optional string venv_objname,
  optional integer venv_selcount,
  optional integer venv_attcount,
  optional integer venv_reccount,
  optional integer venv_bodyformat,
  optional boolean venv_donotclosewindow,
  optional string venv_docparam,
  optional string venv_contextinfo,
  optional string venv_reference,
  optional object venv_property,
  optional string venv_tablevar,
  optional string venv_dispname)

Name

Description

venv_object

venv_tpco

venv_tpce

venv_tag

venv_cleanpoint

venv_objname

venv_selcount

venv_attcount

venv_reccount

venv_bodyformat

venv_donotclosewindow

venv_docparam

venv_contextinfo

venv_reference

venv_property

venv_tablevar

venv_dispname

Additional Information


FSCVENVUI@1.1001:IsBreadcrumbObjectAllowedToSync Permanent link for this heading

Check if the breadcrumb object is allowed to be synchronized locally

boolean FSCVENVUI@1.1001:IsBreadcrumbObjectAllowedToSync(
  out retval boolean allowed)

Name

Description

allowed

returns true if the object is valid for synchronization

Additional Information


FSCVENVUI@1.1001:IsBreadcrumbPathAllowedToSync Permanent link for this heading

Check if the breadcrumb path is allowed to be synchronized locally

boolean FSCVENVUI@1.1001:IsBreadcrumbPathAllowedToSync(
  Breadcrumb[] breadcrumbs,
  out retval boolean allowed)

Name

Description

breadcrumbs

are all breadcrumbs that should be checked

allowed

returns true if the folder structure contained in breadcrumbs are valid

Additional Information


FSCVENVUI@1.1001:IsMailMergeActive Permanent link for this heading

Check if object is marked as mailmerge object

boolean FSCVENVUI@1.1001:IsMailMergeActive(
  out retval boolean active)

Name

Description

active

returns true if the object is a mailmerge object

Additional Information


FSCVENVUI@1.1001:IsMobileAgent Permanent link for this heading

Check for mobile user agent

boolean FSCVENVUI@1.1001:IsMobileAgent(
  out retval boolean ismobile)

Name

Description

ismobile

true for mobile user agents

Additional Information


FSCVENVUI@1.1001:LoginCallback Permanent link for this heading

If the login was successful, this usecase sends a message via Window.postMessage to the window.opener (if the application was started from another window) or window.parent (if the application was started in an iframe

void FSCVENVUI@1.1001:LoginCallback()

Additional Information


FSCVENVUI@1.1001:LogoutCallback Permanent link for this heading

If the logout was successful, this usecase sends a message via Window.postMessage to the window.opener (if the application was started from another window) or window.parent (if the application was started in an iframe

void FSCVENVUI@1.1001:LogoutCallback()

Additional Information


FSCVENVUI@1.1001:MenuAppAccessGet Permanent link for this heading

void FSCVENVUI@1.1001:MenuAppAccessGet(
  optional integer unused1,
  optional integer unused2,
  ref MenuStructList[] menuentries,
  optional object menu,
  optional object[] selobjects,
  out optional boolean addchildren)

Name

Description

unused1

unused2

menuentries

menu

selobjects

addchildren

Additional Information


FSCVENVUI@1.1001:MenuHelpGet Permanent link for this heading

Dynamic menu action to show the online help

void FSCVENVUI@1.1001:MenuHelpGet(
  optional integer unused1,
  optional integer unused2,
  ref MenuStructList[] menuentries,
  optional object menu,
  optional object[] selobjects,
  out optional boolean addchildren)

Name

Description

unused1

unused2

menuentries

menu

selobjects

addchildren

Additional Information


FSCVENVUI@1.1001:OpenFromTool Permanent link for this heading

Open From Office Buttons

void FSCVENVUI@1.1001:OpenFromTool(
  object venv_object,
  string venv_objname,
  object venv_objclass,
  object venv_parent,
  object venv_view,
  string venv_filelocation,
  string venv_filenames)

Name

Description

venv_object

the venv_object

venv_objname

the venv_objname

venv_objclass

the venv_objclass

venv_parent

the venv_parent

venv_view

the venv_view

venv_filelocation

the venv_filelocation

venv_filenames

the venv_filenames

Additional Information


FSCVENVUI@1.1001:OpenOfficeDocument Permanent link for this heading

void FSCVENVUI@1.1001:OpenOfficeDocument(
  object venv_object,
  optional ThirdPartyContextObject venv_tpco,
  optional ThirdPartyContextExternal venv_tpce,
  optional string venv_tag,
  optional string venv_cleanpoint,
  optional string venv_objname,
  optional integer venv_selcount,
  optional integer venv_attcount,
  optional integer venv_reccount,
  optional integer venv_bodyformat,
  optional boolean venv_donotclosewindow,
  optional string venv_docparam,
  optional string venv_contextinfo,
  optional string venv_reference,
  optional object venv_property,
  optional string venv_tablevar,
  optional string venv_dispname)

Name

Description

venv_object

venv_tpco

venv_tpce

venv_tag

venv_cleanpoint

venv_objname

venv_selcount

venv_attcount

venv_reccount

venv_bodyformat

venv_donotclosewindow

venv_docparam

venv_contextinfo

venv_reference

venv_property

venv_tablevar

venv_dispname

Additional Information


FSCVENVUI@1.1001:Redirect2OAuthApp Permanent link for this heading

void FSCVENVUI@1.1001:Redirect2OAuthApp(
  OAuthClient client,
  string code,
  string state,
  boolean usesecclearance,
  boolean confirm)

Name

Description

client

code

state

usesecclearance

confirm

Additional Information


FSCVENVUI@1.1001:RevokeServiceTokenFURL Permanent link for this heading

Revoke an access token for a particular service or application (see also passwords for applications). The access token is identified by the comment (stacomment) and scope (stawsdef).
Requires active configuration of SAML 2.0.

void FSCVENVUI@1.1001:RevokeServiceTokenFURL(
  string comment,
  object scope)

Name

Description

comment

A string that helps the user to determine what the token was created for.

scope

A FSCOWS@1.1001:WebServiceDefiniton object this token was valid for. @see FSCOWS@1.1001:usersetstaccess @see GetServiceTokenFURL

Additional Information


FSCVENVUI@1.1001:ScanAppConfirm Permanent link for this heading

void FSCVENVUI@1.1001:ScanAppConfirm(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVENVUI@1.1001:ScanAppConfirmSelected Permanent link for this heading

void FSCVENVUI@1.1001:ScanAppConfirmSelected(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVENVUI@1.1001:SendAsPointerDirect Permanent link for this heading

define the logo for an object

void FSCVENVUI@1.1001:SendAsPointerDirect(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVENVUI@1.1001:SetCachedContentDirty Permanent link for this heading

This action can be used to set a content in the control content cache as dirty

void FSCVENVUI@1.1001:SetCachedContentDirty(
  string contobj,
  object attrdef,
  integer contid,
  boolean setisdirty,
  boolean silent)

Name

Description

contobj

The content object.

attrdef

Content attribute definition.

contid

setisdirty

Mark the content as dirty.

silent

all error will be swallowed silently

Additional Information


FSCVENVUI@1.1001:SettingsOverview Permanent link for this heading

void FSCVENVUI@1.1001:SettingsOverview(
  Prerequisite[] venv_prerequfailed,
  Prerequisite[] venv_prerequfailedopt,
  Prerequisite[] venv_prerequpassed)

Name

Description

venv_prerequfailed

venv_prerequfailedopt

venv_prerequpassed

Additional Information


FSCVENVUI@1.1001:ShowAppAccess Permanent link for this heading

void FSCVENVUI@1.1001:ShowAppAccess(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVENVUI@1.1001:ShowBrowserStatus Permanent link for this heading

void FSCVENVUI@1.1001:ShowBrowserStatus(
  Prerequisite[] venv_prerequfailed,
  Prerequisite[] venv_prerequfailedopt,
  Prerequisite[] venv_prerequpassed,
  optional string venv_pagelabel)

Name

Description

venv_prerequfailed

venv_prerequfailedopt

venv_prerequpassed

venv_pagelabel

Additional Information


FSCVENVUI@1.1001:ShowOfflineSync Permanent link for this heading

void FSCVENVUI@1.1001:ShowOfflineSync(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVENVUI@1.1001:SynchronizeFolder Permanent link for this heading

Menu to synchronize current container

void FSCVENVUI@1.1001:SynchronizeFolder(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVENVUI@1.1001:TPAccessCheckGetMenuItems Permanent link for this heading

void FSCVENVUI@1.1001:TPAccessCheckGetMenuItems(
  ref RibbonControlStruct control)

Name

Description

control

Additional Information


FSCVENVUI@1.1001:TPAssignProperties Permanent link for this heading

void FSCVENVUI@1.1001:TPAssignProperties(
  object[] objs,
  string[] names,
  string[] types)

Name

Description

objs

names

types

Additional Information


FSCVENVUI@1.1001:TPAssignTextModule Permanent link for this heading

void FSCVENVUI@1.1001:TPAssignTextModule(
  boolean binary,
  string module,
  string content,
  optional string type,
  optional integer size,
  out optional string[] nestedmodules)

Name

Description

binary

module

content

type

size

nestedmodules

Additional Information


FSCVENVUI@1.1001:TPAttachBinary Permanent link for this heading

Insert a content as attachment into an email.
Use within @RibbonApplicationPrototype applications.

void FSCVENVUI@1.1001:TPAttachBinary(
  string value,
  string extension,
  integer size,
  optional string name)

Name

Description

value

base64 content to be inserted.

extension

extension of the binary formatted text.

size

bytes of the base64 content as integer.

name

optional name of the file.

Additional Information


FSCVENVUI@1.1001:TPAttrChanged Permanent link for this heading

Notify about changed objects on the client side. Use within @RibbonApplicationPrototype applications.

void FSCVENVUI@1.1001:TPAttrChanged(
  optional object[] objects)

Name

Description

objects

Additional Information


FSCVENVUI@1.1001:TPBeforeImport Permanent link for this heading

Deliver all available MAPI tags or its values from the client. When propdeflist is set, the values of the MAPI properties are returned.
Use within @RibbonApplicationPrototype applications.

string FSCVENVUI@1.1001:TPBeforeImport(
  boolean isselection,
  boolean isrecipient,
  boolean isattachment,
  integer idx,
  optional string propdeflist,
  out retval string result)

Name

Description

isselection

defines if the MAPI tags should only be delivered for selections.

isrecipient

defines if the MAPI tags should only be delivered for recipient.

isattachment

defines if the MAPI tags should only be delivered for attachments.

idx

is the index of the appropriate selection, recipient or attachment.

propdeflist

is a string list of integer values e.g. [int1,int2]

result

returns a json string with all available mapi tags .

Additional Information


FSCVENVUI@1.1001:TPCheckSentPointerAccessApp Permanent link for this heading

void FSCVENVUI@1.1001:TPCheckSentPointerAccessApp(
  object venv_object,
  optional ThirdPartyContextObject venv_tpco,
  optional ThirdPartyContextExternal venv_tpce,
  optional string venv_tag,
  optional string venv_cleanpoint,
  optional string venv_objname,
  optional integer venv_selcount,
  optional integer venv_attcount,
  optional integer venv_reccount,
  optional integer venv_bodyformat,
  optional boolean venv_donotclosewindow,
  optional string venv_docparam,
  optional string venv_contextinfo,
  optional string venv_reference,
  optional object venv_property,
  optional string venv_tablevar,
  optional string venv_dispname)

Name

Description

venv_object

venv_tpco

venv_tpce

venv_tag

venv_cleanpoint

venv_objname

venv_selcount

venv_attcount

venv_reccount

venv_bodyformat

venv_donotclosewindow

venv_docparam

venv_contextinfo

venv_reference

venv_property

venv_tablevar

venv_dispname

Additional Information


FSCVENVUI@1.1001:TPCloseDocument Permanent link for this heading

Close the document on the client side. Use within @RibbonApplicationPrototype applications.

void FSCVENVUI@1.1001:TPCloseDocument()

Additional Information


FSCVENVUI@1.1001:TPConcludeImport Permanent link for this heading

Cleanup files on the client side. Necessary if TPPrepareImport, TPBeforeImport, TPGetEmailAdressForRecipients. TPGetEmailAttachmentsPath was called before.
Use within @RibbonApplicationPrototype applications.

void FSCVENVUI@1.1001:TPConcludeImport(
  boolean isselection,
  boolean isrecipient,
  boolean isattachment,
  boolean remove)

Name

Description

isselection

the conclude event should only be triggered for selections.

isrecipient

the conclude event should only be triggered for recipients.

isattachment

the conclude event should only be triggered for attachments.

remove

boolean to remove attachments from an email.

Additional Information


FSCVENVUI@1.1001:TPCopyLinkApp Permanent link for this heading

Application to copy a link in the outlook ribbon

void FSCVENVUI@1.1001:TPCopyLinkApp(
  object venv_object,
  optional ThirdPartyContextObject venv_tpco,
  optional ThirdPartyContextExternal venv_tpce,
  optional string venv_tag,
  optional string venv_cleanpoint,
  optional string venv_objname,
  optional integer venv_selcount,
  optional integer venv_attcount,
  optional integer venv_reccount,
  optional integer venv_bodyformat,
  optional boolean venv_donotclosewindow,
  optional string venv_docparam,
  optional string venv_contextinfo,
  optional string venv_reference,
  optional object venv_property,
  optional string venv_tablevar,
  optional string venv_dispname)

Name

Description

venv_object

venv_tpco

venv_tpce

venv_tag

venv_cleanpoint

venv_objname

venv_selcount

venv_attcount

venv_reccount

venv_bodyformat

venv_donotclosewindow

venv_docparam

venv_contextinfo

venv_reference

venv_property

venv_tablevar

venv_dispname

Additional Information


FSCVENVUI@1.1001:TPDissolveTextModules Permanent link for this heading

void FSCVENVUI@1.1001:TPDissolveTextModules(
  string[] topmodules)

Name

Description

topmodules

Additional Information


FSCVENVUI@1.1001:TPDocumentTreeConnect Permanent link for this heading

This application allow to define a target folder to import mails from a defined outlook folder.
Use within @RibbonApplicationPrototype applications.

void FSCVENVUI@1.1001:TPDocumentTreeConnect(
  object targetobj,
  boolean isencrypted)

Name

Description

targetobj

target folder.

isencrypted

Additional Information


FSCVENVUI@1.1001:TPDocumentTreeCreate Permanent link for this heading

This application allow creating document trees in an external application.
Use within @RibbonApplicationPrototype applications.

string FSCVENVUI@1.1001:TPDocumentTreeCreate(
  boolean leaf,
  ref retval string keys,
  optional string displayname,
  optional ThirdPartyContextExport tpce,
  optional string messageclass)

Name

Description

leaf

true if an item should be created instead of an folder.

keys

json containing the appropriate keys.

displayname

displayname only used for creating folders.

tpce

ThirdPartyContextExport only used for creating folders.

messageclass

type of item that should be created, only for leafs.

Additional Information


FSCVENVUI@1.1001:TPDocumentTreeModify Permanent link for this heading

This application allow modifying document trees in an external application.
Use within @RibbonApplicationPrototype applications.

string FSCVENVUI@1.1001:TPDocumentTreeModify(
  boolean leaf,
  string keys,
  string vals,
  out retval string errors)

Name

Description

leaf

true if an item should be modified.

keys

json containing the appropriate keys.

vals

json values that should be modified (json).

errors

json containing the error messages.

Additional Information


FSCVENVUI@1.1001:TPDocumentTreeRemove Permanent link for this heading

This application allow removing document trees in an external application.
Use within @RibbonApplicationPrototype applications.

void FSCVENVUI@1.1001:TPDocumentTreeRemove(
  boolean leaf,
  string keys)

Name

Description

leaf

true if an item should be removed.

keys

delete only this item/folder .

Additional Information


FSCVENVUI@1.1001:TPGetEmailAdressForRecipients Permanent link for this heading

Collect all e-mail addresses from an opened e-mail. For deleting temporary files call TPConcludeImport after your usecase (isrecipient = true).
Use within @RibbonApplicationPrototype applications.

string FSCVENVUI@1.1001:TPGetEmailAdressForRecipients(
  integer venv_reccount,
  out retval string mails)

Name

Description

venv_reccount

how many recipients are defined in the e-mail.

mails

returns the email addresses and additional information as JSON string.

Additional Information


FSCVENVUI@1.1001:TPGetEmailAttachmentsPath Permanent link for this heading

This application deliver all attachments form an opened e-mail, without inline attachments. For deleting temporary files call TPConcludeImport after your usecase (isattachment = true).
Use within @RibbonApplicationPrototype applications.

string FSCVENVUI@1.1001:TPGetEmailAttachmentsPath(
  integer venv_attcount,
  out retval string path)

Name

Description

venv_attcount

how many attachments are defined in the e-mail.

path

the path to the folder containing all attachments.

Additional Information


FSCVENVUI@1.1001:TPGetFormattedModules Permanent link for this heading

This application returns all text module objects from an word document opened editing.
Use within @RibbonApplicationPrototype applications.

string FSCVENVUI@1.1001:TPGetFormattedModules(
  optional integer fscope,
  out retval string objects)

Name

Description

fscope

return all formatted placeholder in the document (0) or all placeholder of the current selection/position of the insertion point (1).

objects

json string with all formatted modules.

Additional Information


FSCVENVUI@1.1001:TPGetLinkedObjects Permanent link for this heading

This application deliver all linked objects from an email opened editing.
Use within @RibbonApplicationPrototype applications.

string FSCVENVUI@1.1001:TPGetLinkedObjects(
  out retval string objects)

Name

Description

objects

json string with all linked objects.

Additional Information


FSCVENVUI@1.1001:TPGetObjectFromModuleTag Permanent link for this heading

string FSCVENVUI@1.1001:TPGetObjectFromModuleTag(
  string module,
  out retval string objaddr,
  ref optional string cleanpointutc)

Name

Description

module

objaddr

cleanpointutc

Additional Information


FSCVENVUI@1.1001:TPGetPlainModules Permanent link for this heading

This application returns all text module objects from an word document opened editing.
Use within @RibbonApplicationPrototype applications.

string FSCVENVUI@1.1001:TPGetPlainModules(
  optional integer pscope,
  out retval string objects)

Name

Description

pscope

return all plain placeholder in the document (0) or all placeholder of the current selection/position of the insertion point (1).

objects

json string with all plain modules.

Additional Information


FSCVENVUI@1.1001:TPImportDocumentTrack Permanent link for this heading

Tracking imported document on the client side, same as opened from the web client.
Use within @RibbonApplicationPrototype applications.

void FSCVENVUI@1.1001:TPImportDocumentTrack(
  dictionary fileinfo)

Name

Description

fileinfo

containing file information like uri, locktoken and cleanpoint.

Additional Information


FSCVENVUI@1.1001:TPInsertBinary Permanent link for this heading

Sets a binary text at the cursor position in the document.
Use within @RibbonApplicationPrototype applications.

void FSCVENVUI@1.1001:TPInsertBinary(
  string bvalue,
  string bextension,
  integer bsize,
  optional string bobject,
  optional integer bscope,
  optional string bframetype,
  optional string bname,
  optional string bcleanpoint)

Name

Description

bvalue

base64 content to be inserted.

bextension

extension of the binary formatted text.

bsize

size of the text to be inserted.

bobject

object where the object URL(formattedplaceholder) should be replaced in the document.

bscope

replace all elements of "bobject" in the document (0), all elements of bobject in the selection (1) or replace the whole selection (2). This can only be used with a set "bobject" parameter.

bframetype

insert element as no border ("") or as embedded modue (("P"|"U")["M"|"O"]). This can only be used with a set "bobject" parameter.

bname

name of embedded text module

bcleanpoint

content changed date of embedded text module (ISO format)

Additional Information


FSCVENVUI@1.1001:TPInsertFormatted Permanent link for this heading

Set a formatted text at the cursor position in the document.
Use within @RibbonApplicationPrototype applications.

void FSCVENVUI@1.1001:TPInsertFormatted(
  string fvalue,
  string fextension,
  optional string fobject,
  optional integer fscope,
  optional string fframetype)

Name

Description

fvalue

formatted text to be inserted.

fextension

extension of the formatted text.

fobject

object where the object URL(formattedplaceholder) should be replaced in the document.

fscope

replace all elements of "fobject" in the document (0), all elements of fobject in the selection (1) or replace the whole selection (2). This can only be used with a set "fobject" parameter.

fframetype

insert element as no border ("") or as embedded modue (("P"|"U")["M"|"O"]). This can only be used with a set "fobject" parameter.

Additional Information


FSCVENVUI@1.1001:TPInsertLinkFormatted Permanent link for this heading

Sets a formatted link text at the cursor position in the document.
Use within @RibbonApplicationPrototype applications.

void FSCVENVUI@1.1001:TPInsertLinkFormatted(
  string davuri)

Name

Description

davuri

davuri to be inserted.

Additional Information


FSCVENVUI@1.1001:TPInsertLinkPlain Permanent link for this heading

Sets a plain link text at the cursor position in the document.
Use within @RibbonApplicationPrototype applications.

void FSCVENVUI@1.1001:TPInsertLinkPlain(
  string docproperty)

Name

Description

docproperty

docproperty to be inserted.

Additional Information


FSCVENVUI@1.1001:TPInsertPlain Permanent link for this heading

Set a plain text at the cursor position in the document.
Use within @RibbonApplicationPrototype applications.

void FSCVENVUI@1.1001:TPInsertPlain(
  string pvalue,
  optional string pobject,
  optional integer pscope,
  optional string pframetype,
  optional string pname,
  optional string pcleanpoint)

Name

Description

pvalue

plain text to be inserted.

pobject

object where the object URL(plainplaceholder) should be replaced in the document.

pscope

replace all elements of "pobject" in the document (0), all elements of pobject in the selection (1) or replace the whole selection (2). This can only be used with a set "pobject" parameter.

pframetype

insert element as no border ("") or as embedded modue (("P"|"U")["M"|"O"]). This can only be used with a set "pobject" parameter.

pname

name of embedded text module

pcleanpoint

content changed date of embedded text module (ISO format)

Additional Information


FSCVENVUI@1.1001:TPInsertShape Permanent link for this heading

Insert a rectangular shape at the cursor position in the document.
Use within @RibbonApplicationPrototype applications.

void FSCVENVUI@1.1001:TPInsertShape(
  optional string uri,
  optional integer shapetype,
  optional integer shapewidth,
  optional integer shapeheight)

Name

Description

uri

defines the URL stored at the shape.

shapetype

defines the type of the shape.
  • 1 = rectangular

shapewidth

defines the width of the shape.

shapeheight

defines the height of the shape.

Additional Information


FSCVENVUI@1.1001:TPIsDocumentClean Permanent link for this heading

Retrieve the information if the document on the client side is clean or not. Use within @RibbonApplicationPrototype applications.

boolean FSCVENVUI@1.1001:TPIsDocumentClean(
  out retval boolean clean)

Name

Description

clean

Additional Information


FSCVENVUI@1.1001:TPModifyProperties Permanent link for this heading

This application allow modifying properties of predefined items.
Use within @RibbonApplicationPrototype applications.

void FSCVENVUI@1.1001:TPModifyProperties(
  boolean isselection,
  boolean isrecipient,
  boolean isattachment,
  string json,
  integer idx)

Name

Description

isselection

modify properties of a selected item.

isrecipient

modify properties of a recipient item.

isattachment

modify properties of an attachment item.

json

properties to change.

idx

index which item should be modified.

Additional Information


FSCVENVUI@1.1001:TPNestedModules Permanent link for this heading

void FSCVENVUI@1.1001:TPNestedModules(
  string[] modules,
  out string[] nestedmodules)

Name

Description

modules

nestedmodules

Additional Information


FSCVENVUI@1.1001:TPPrepareImport Permanent link for this heading

Prepare document or attachments or the selection on the client side for importing.
Use within @RibbonApplicationPrototype applications.

string FSCVENVUI@1.1001:TPPrepareImport(
  boolean isattachment,
  boolean isselection,
  optional string param,
  out retval string filepath)

Name

Description

isattachment

isselection

param

  • Microsoft Word, Microsoft Excel or Microsoft PowerPoint this parameter will be the name of the document.
  • Microsoft Outlook this parameter is the index of the imported document or attachment, if no index was supplied the whole selection or all attachments will be imported.

filepath

returns full path to file.

Additional Information


FSCVENVUI@1.1001:TPPropertiesApp Permanent link for this heading

Application to open the properties in the outlook ribbon

void FSCVENVUI@1.1001:TPPropertiesApp(
  object venv_object,
  optional ThirdPartyContextObject venv_tpco,
  optional ThirdPartyContextExternal venv_tpce,
  optional string venv_tag,
  optional string venv_cleanpoint,
  optional string venv_objname,
  optional integer venv_selcount,
  optional integer venv_attcount,
  optional integer venv_reccount,
  optional integer venv_bodyformat,
  optional boolean venv_donotclosewindow,
  optional string venv_docparam,
  optional string venv_contextinfo,
  optional string venv_reference,
  optional object venv_property,
  optional string venv_tablevar,
  optional string venv_dispname)

Name

Description

venv_object

venv_tpco

venv_tpce

venv_tag

venv_cleanpoint

venv_objname

venv_selcount

venv_attcount

venv_reccount

venv_bodyformat

venv_donotclosewindow

venv_docparam

venv_contextinfo

venv_reference

venv_property

venv_tablevar

venv_dispname

Additional Information


FSCVENVUI@1.1001:TPProtectableTextModules Permanent link for this heading

void FSCVENVUI@1.1001:TPProtectableTextModules(
  out string[] allobjs)

Name

Description

allobjs

Additional Information


FSCVENVUI@1.1001:TPPublicLinkApp Permanent link for this heading

Application to send a public link in the outlook ribbon

void FSCVENVUI@1.1001:TPPublicLinkApp(
  object venv_object,
  optional ThirdPartyContextObject venv_tpco,
  optional ThirdPartyContextExternal venv_tpce,
  optional string venv_tag,
  optional string venv_cleanpoint,
  optional string venv_objname,
  optional integer venv_selcount,
  optional integer venv_attcount,
  optional integer venv_reccount,
  optional integer venv_bodyformat,
  optional boolean venv_donotclosewindow,
  optional string venv_docparam,
  optional string venv_contextinfo,
  optional string venv_reference,
  optional object venv_property,
  optional string venv_tablevar,
  optional string venv_dispname)

Name

Description

venv_object

venv_tpco

venv_tpce

venv_tag

venv_cleanpoint

venv_objname

venv_selcount

venv_attcount

venv_reccount

venv_bodyformat

venv_donotclosewindow

venv_docparam

venv_contextinfo

venv_reference

venv_property

venv_tablevar

venv_dispname

Additional Information


FSCVENVUI@1.1001:TPRemoveTextModules Permanent link for this heading

void FSCVENVUI@1.1001:TPRemoveTextModules(
  string[] modules)

Name

Description

modules

Additional Information


FSCVENVUI@1.1001:TPRenameApp Permanent link for this heading

Application to rename the object in the outlook ribbon

void FSCVENVUI@1.1001:TPRenameApp(
  object venv_object,
  optional ThirdPartyContextObject venv_tpco,
  optional ThirdPartyContextExternal venv_tpce,
  optional string venv_tag,
  optional string venv_cleanpoint,
  optional string venv_objname,
  optional integer venv_selcount,
  optional integer venv_attcount,
  optional integer venv_reccount,
  optional integer venv_bodyformat,
  optional boolean venv_donotclosewindow,
  optional string venv_docparam,
  optional string venv_contextinfo,
  optional string venv_reference,
  optional object venv_property,
  optional string venv_tablevar,
  optional string venv_dispname)

Name

Description

venv_object

venv_tpco

venv_tpce

venv_tag

venv_cleanpoint

venv_objname

venv_selcount

venv_attcount

venv_reccount

venv_bodyformat

venv_donotclosewindow

venv_docparam

venv_contextinfo

venv_reference

venv_property

venv_tablevar

venv_dispname

Additional Information


FSCVENVUI@1.1001:TPSaveDocument Permanent link for this heading

Save the document on the client side. Use within @RibbonApplicationPrototype applications.

void FSCVENVUI@1.1001:TPSaveDocument()

Additional Information


FSCVENVUI@1.1001:TPSendLinkApp Permanent link for this heading

Application to send a link in the outlook ribbon

void FSCVENVUI@1.1001:TPSendLinkApp(
  object venv_object,
  optional ThirdPartyContextObject venv_tpco,
  optional ThirdPartyContextExternal venv_tpce,
  optional string venv_tag,
  optional string venv_cleanpoint,
  optional string venv_objname,
  optional integer venv_selcount,
  optional integer venv_attcount,
  optional integer venv_reccount,
  optional integer venv_bodyformat,
  optional boolean venv_donotclosewindow,
  optional string venv_docparam,
  optional string venv_contextinfo,
  optional string venv_reference,
  optional object venv_property,
  optional string venv_tablevar,
  optional string venv_dispname)

Name

Description

venv_object

venv_tpco

venv_tpce

venv_tag

venv_cleanpoint

venv_objname

venv_selcount

venv_attcount

venv_reccount

venv_bodyformat

venv_donotclosewindow

venv_docparam

venv_contextinfo

venv_reference

venv_property

venv_tablevar

venv_dispname

Additional Information


FSCVENVUI@1.1001:TPSetCleanpointAtTag Permanent link for this heading

void FSCVENVUI@1.1001:TPSetCleanpointAtTag(
  string cleanpointutc,
  ref string module)

Name

Description

cleanpointutc

module

Additional Information


FSCVENVUI@1.1001:TPSetDocumentClean Permanent link for this heading

Set the document clean or dirty on the client side. Use within @RibbonApplicationPrototype applications.

void FSCVENVUI@1.1001:TPSetDocumentClean(
  boolean clean)

Name

Description

clean

Additional Information


FSCVENVUI@1.1001:TPSetDocumentCleanPoint Permanent link for this heading

Set a new clean point for the document on the client side. Use within @RibbonApplicationPrototype applications.

void FSCVENVUI@1.1001:TPSetDocumentCleanPoint(
  optional datetime cleanpoint)

Name

Description

cleanpoint

Additional Information


FSCVENVUI@1.1001:TPSetProtectionType Permanent link for this heading

void FSCVENVUI@1.1001:TPSetProtectionType(
  ThirdPartyContentProtection protection,
  ref string module)

Name

Description

protection

module

Additional Information


FSCVENVUI@1.1001:TPTextModuleProtectionGet Permanent link for this heading

This action defines the protection requirements for embedded text modules as follows:

If the user does not have set-access to the property content of the text module object, protection against both removal and content modification is requested.
Otherwise, protection withdrawal is requested.

ThirdPartyContentProtection[] FSCVENVUI@1.1001:TPTextModuleProtectionGet(
  object[] modules,
  out retval ThirdPartyContentProtection[] protections)

Name

Description

modules

text modules embedded in a document endued with protection facilities.

protections

requested protection.

Additional Information


FSCVENVUI@1.1001:TPTopTextModules Permanent link for this heading

void FSCVENVUI@1.1001:TPTopTextModules(
  integer scope,
  integer condition,
  out string[] topmodules)

Name

Description

scope

condition

topmodules

Additional Information


FSCVENVUI@1.1001:TPTouchTextModule Permanent link for this heading

void FSCVENVUI@1.1001:TPTouchTextModule(
  string module,
  string name)

Name

Description

module

name

Additional Information


FSCVENVUI@1.1001:TPUpdateDocProperties Permanent link for this heading

Update the document properties on the client side. Use within @RibbonApplicationPrototype applications.

void FSCVENVUI@1.1001:TPUpdateDocProperties(
  optional dictionary entries)

Name

Description

entries

Additional Information


FSCVENVUI@1.1001:TPUpdateExternalRibbon Permanent link for this heading

Update the document ribbon on the client side. Use within @RibbonApplicationPrototype applications.

void FSCVENVUI@1.1001:TPUpdateExternalRibbon(
  RibbonControlSite rcsite)

Name

Description

rcsite

Additional Information


FSCVENVUI@1.1001:TPUpdateFields Permanent link for this heading

Update the document fields on the client side. Use within @RibbonApplicationPrototype applications.

void FSCVENVUI@1.1001:TPUpdateFields(
  optional dictionary entries)

Name

Description

entries

Additional Information


FSCVENVUI@1.1001:TPUpdateObjectRibbon Permanent link for this heading

Update the object ribbon on the client side. Use within @RibbonApplicationPrototype applications.

void FSCVENVUI@1.1001:TPUpdateObjectRibbon(
  RibbonControlSite rcsite)

Name

Description

rcsite

Additional Information