2022 June Release

Class FSCTEAMROOM@1.1001:Room Permanent link for this heading

Class Hierarchy

Object > CompoundObject > Room

Abstract base class to mange the security for a bunch of objects

Properties Permanent link for this heading

Type

Property

Name

Thesaurus

acrdefaultthesaurus

Default Thesaurus for New Terms

Object[]

acreporttemplates

Reports and OData Services

Thesaurus[]

acrthesauri

Thesauri

Object

bostate

Processing State

Room[]

trallorphanteamrooms

Orphan Teamrooms (incl. Hierarchy)

boolean

trallowrestrictedcollaboratorhistory

Display Notifications for Users Without Rights to View the Team

Room[]

trallreferencedteamrooms

Referenced Teamrooms (incl. Hierarchy)

Room[]

trallsubordinatedteamrooms

Subordinate Teamrooms (incl. Hierarchy)

Group[]

trcollaborationscope

Restrict Team Members

boolean

trdelegateinvitation

All Team Members May Add Members

InsightApp[]

trinsightapps

Insight Apps

User

trinvitedby

Invited by

LinkUsage

trlinkusage

Restrict Shortcuts Within Teamroom

User[]

trmasterrolemembers

Team Members Who Can Manage All Roles

Room[]

trorphanteamrooms

Orphan Teamrooms

boolean

trpublicaccess

Allow Public Links

RoomPublishState

trpublishstate

Access Protection

Room[]

trreferencedteamrooms

Referenced Teamrooms

Room[]

trreferencingteamrooms

Referencing Teamrooms

boolean

trrequireinherittemplatesecurity

Security Settings and Permissions Must Be Taken From the Template

boolean

trshowcollaborators

Team Members With Read Access Visible to All Members

Room[]

trsubordinatedteamrooms

Subordinate Teamrooms

Room

trsuperordinatedteamroom

Superordinate Teamroom

Object[]

trtemplates

Templates

AppCategory

trtype

Type

Actions Permanent link for this heading

Return Type

Signature

boolean

CanReleaseTemplate(
  out retval boolean canrelease)

Content

GetLogo(
  out retval Content logo,
  optional LogoType type,
  out object source)

MBInSpireService

GetMBInSpireService(
  out retval MBInSpireService svc,
  optional object context)

Room

GetObjectRoom(
  out retval Room room,
  optional boolean includeself)

User[]

GetTeamMembersSecured(
  optional boolean expandorgelements,
  optional RoomRole[] roles,
  out retval User[] members,
  out optional object[] groups)

RoomRole[]

GetUserRoomRolesSecured(
  User targetuser,
  out retval RoomRole[] roles)

boolean

HasRoomCustomAssignmentAccess(
  User user,
  out retval boolean hasaccess,
  optional object context)

boolean

HasRoomDeleteAccess(
  optional User user,
  out retval boolean hasdeleteaccess)

Properties Permanent link for this heading


Default Thesaurus for New Terms (FSCTEAMROOM@1.1001:acrdefaultthesaurus) Permanent link for this heading

Thesaurus FSCTEAMROOM@1.1001:acrdefaultthesaurus readonly

Additional Information


Reports and OData Services (FSCREPORTING@1.1001:acreporttemplates) Permanent link for this heading

List of report templates

unique Object[] FSCREPORTING@1.1001:acreporttemplates

Additional Information


Thesauri (FSCTEAMROOM@1.1001:acrthesauri) Permanent link for this heading

Thesaurus[] FSCTEAMROOM@1.1001:acrthesauri readonly volatile

Additional Information


Processing State (FSCFOLIO@1.1001:bostate) Permanent link for this heading

Defines the processing state of the object
FSCFOLIO@1.1001 provides following state component objects:
StateAccepted, StateApproved, StateCalculating, StateCanceled, StateClosed, StateDeclined, StateDiscarded, StateDone, StateFailed, StateForApproval, StateFulfilled, StateIgnored, StateInProgress, StateNotReleased, StateNotRelevant, StatePlanning, StatePreparation, StateReceived, StateRejected, StateReleased, StateReplaced, StateTentative, StateToVerify, StateUnfulfilled

Object FSCFOLIO@1.1001:bostate

Additional Information


Orphan Teamrooms (incl. Hierarchy) (FSCTEAMROOM@1.1001:trallorphanteamrooms) Permanent link for this heading

unique Room[] FSCTEAMROOM@1.1001:trallorphanteamrooms readonly volatile

Additional Information


Display Notifications for Users Without Rights to View the Team (FSCTEAMROOM@1.1001:trallowrestrictedcollaboratorhistory) Permanent link for this heading

boolean FSCTEAMROOM@1.1001:trallowrestrictedcollaboratorhistory

Additional Information


Referenced Teamrooms (incl. Hierarchy) (FSCTEAMROOM@1.1001:trallreferencedteamrooms) Permanent link for this heading

unique Room[] FSCTEAMROOM@1.1001:trallreferencedteamrooms readonly volatile

Additional Information


Subordinate Teamrooms (incl. Hierarchy) (FSCTEAMROOM@1.1001:trallsubordinatedteamrooms) Permanent link for this heading

unique Room[] FSCTEAMROOM@1.1001:trallsubordinatedteamrooms readonly volatile

Additional Information


Restrict Team Members (FSCTEAMROOM@1.1001:trcollaborationscope) Permanent link for this heading

Only members of the defined groups can be invite for collaboration

unique Group[] FSCTEAMROOM@1.1001:trcollaborationscope

Additional Information


All Team Members May Add Members (FSCTEAMROOM@1.1001:trdelegateinvitation) Permanent link for this heading

Configuration to allow delegated invitations

boolean FSCTEAMROOM@1.1001:trdelegateinvitation

Additional Information


Insight Apps (FSCMINDBREEZEINSIGHT@1.1001:trinsightapps) Permanent link for this heading

unique InsightApp[] FSCMINDBREEZEINSIGHT@1.1001:trinsightapps

Additional Information


Invited by (FSCTEAMROOM@1.1001:trinvitedby) Permanent link for this heading

User FSCTEAMROOM@1.1001:trinvitedby readonly volatile


Restrict Shortcuts Within Teamroom (FSCTEAMROOM@1.1001:trlinkusage) Permanent link for this heading

Allowed objects in child attributes of the room and it's assigned objects are restricted by this property

LinkUsage FSCTEAMROOM@1.1001:trlinkusage

Additional Information


Team Members Who Can Manage All Roles (FSCTEAMROOM@1.1001:trmasterrolemembers) Permanent link for this heading

Members of the master roles of the room

User[] FSCTEAMROOM@1.1001:trmasterrolemembers readonly volatile invisible

Additional Information


Orphan Teamrooms (FSCTEAMROOM@1.1001:trorphanteamrooms) Permanent link for this heading

unique Room[] FSCTEAMROOM@1.1001:trorphanteamrooms readonly volatile

Additional Information


Allow Public Links (FSCTEAMROOM@1.1001:trpublicaccess) Permanent link for this heading

Configuration to allow public access to objects of the team room.

boolean FSCTEAMROOM@1.1001:trpublicaccess

Additional Information


Access Protection (FSCTEAMROOM@1.1001:trpublishstate) Permanent link for this heading

Publishing state of a team room

Note: The ACL of the room depends on its publishing state

RoomPublishState FSCTEAMROOM@1.1001:trpublishstate not null

Additional Information


Referenced Teamrooms (FSCTEAMROOM@1.1001:trreferencedteamrooms) Permanent link for this heading

unique Room[] FSCTEAMROOM@1.1001:trreferencedteamrooms readonly

Additional Information


Referencing Teamrooms (FSCTEAMROOM@1.1001:trreferencingteamrooms) Permanent link for this heading

unique Room[] FSCTEAMROOM@1.1001:trreferencingteamrooms readonly

Additional Information


Security Settings and Permissions Must Be Taken From the Template (FSCTEAMROOM@1.1001:trrequireinherittemplatesecurity) Permanent link for this heading

boolean FSCTEAMROOM@1.1001:trrequireinherittemplatesecurity


Team Members With Read Access Visible to All Members (FSCTEAMROOM@1.1001:trshowcollaborators) Permanent link for this heading

Configuration to allow team room members to see other collaborators of the team room

boolean FSCTEAMROOM@1.1001:trshowcollaborators

Additional Information


Subordinate Teamrooms (FSCTEAMROOM@1.1001:trsubordinatedteamrooms) Permanent link for this heading

unique Room[] FSCTEAMROOM@1.1001:trsubordinatedteamrooms readonly

Additional Information


Superordinate Teamroom (FSCTEAMROOM@1.1001:trsuperordinatedteamroom) Permanent link for this heading

Room FSCTEAMROOM@1.1001:trsuperordinatedteamroom readonly

Additional Information


Templates (FSCTEAMROOM@1.1001:trtemplates) Permanent link for this heading

Team Room Templates

Object[] FSCTEAMROOM@1.1001:trtemplates volatile

Additional Information


Type (FSCTEAMROOM@1.1001:trtype) Permanent link for this heading

App category of the team room

AppCategory FSCTEAMROOM@1.1001:trtype

Additional Information

Actions Permanent link for this heading


COOTC@1.1001:CanReleaseTemplate Permanent link for this heading

Check if the current user is allowed to release a template or to withdraw the release

boolean COOTC@1.1001:CanReleaseTemplate(
  out retval boolean canrelease)

Name

Description

canrelease

the result;

COODESK@1.1:GetLogo Permanent link for this heading

Retrieves a logo for the current object. The type of logo is defined by LogoType.
Since the source of a logo, i.e. the object which stores the logo, may differ from the current object, GetLogo will also return this source object.
To determine the source object, GetLogo will evaluate the customization GetLogoContainer.
GetLogo will retrieve the logo image either from objlogoimage or objlogothumbimage. If there is no content available in these properties, the logo will be retrieved from the object stored in objlogoref.
If no logo content could be retrieved, the parameter logo and source will not be set.

Content COODESK@1.1:GetLogo(
  out retval Content logo,
  optional LogoType type,
  out object source)

Name

Description

logo

The logo image. Only contents of type png, svg, jpg or gif are allowed.

type

The type of logo that should be retrieved. The type will be used as key in the customization GetLogoContainer. The default value is LT_CONTENT.

source

The object that stores the logo content.

FSCMINDBREEZE@1.1001:GetMBInSpireService Permanent link for this heading

Determine Mindbreeze Inspire Service

MBInSpireService FSCMINDBREEZE@1.1001:GetMBInSpireService(
  out retval MBInSpireService svc,
  optional object context)

Name

Description

svc

InSpire service

context

Context for service selection

FSCTEAMROOM@1.1001:GetObjectRoom Permanent link for this heading

Action to retrieve the room of an object

Room FSCTEAMROOM@1.1001:GetObjectRoom(
  out retval Room room,
  optional boolean includeself)

Name

Description

room

the room

includeself

if the current object is a room it will return himself. By default no room will be returned for a room. This parameter has no effect for other objects.

FSCTEAMROOM@1.1001:GetTeamMembersSecured Permanent link for this heading

Returns the users directly authorized in the room. If the parameter expandorgelements is set to true, then the users contained in authorized organizational elements are also returned.

User[] FSCTEAMROOM@1.1001:GetTeamMembersSecured(
  optional boolean expandorgelements,
  optional RoomRole[] roles,
  out retval User[] members,
  out optional object[] groups)

Name

Description

expandorgelements

If set, all organizational elements will be resolved to users.

roles

If set, only users with the specified role will be returned.
In a Teamroom or a room with user data, the roles RoleTeamRoomFullControl, RoleTeamRoomChangeAccess and RoleTeamRoomReadAccess can be used.
In an app configuration, usually the roles RoleAppConfigurationRoomAdmin and RoleAppConfigurationRoomUser are available.

members

The team members.

groups

The authorized organizational elements

FSCTEAMROOM@1.1001:GetUserRoomRolesSecured Permanent link for this heading

This action retrieves the room roles which are assigned to the supplied user.

RoomRole[] FSCTEAMROOM@1.1001:GetUserRoomRolesSecured(
  User targetuser,
  out retval RoomRole[] roles)

Name

Description

targetuser

The user for whom the roles should be evaluated.

roles

RoomRoles which are assigned to the specified user.

FSCTEAMROOM@1.1001:HasRoomCustomAssignmentAccess Permanent link for this heading

Check if the supplied user can assign a new object to the room. This action is used to allow to assign an object to an app Room when the user does not have the sufficient access permissions returned by HasRoomFullControl, HasRoomChangeAccess and HasRoomChildChangeAccess

boolean FSCTEAMROOM@1.1001:HasRoomCustomAssignmentAccess(
  User user,
  out retval boolean hasaccess,
  optional object context)

Name

Description

user

the user for whom the permission will be checked

hasaccess

the result

context

the object which should be assigned to the room

FSCTEAMROOM@1.1001:HasRoomDeleteAccess Permanent link for this heading

Checks for change access on the room or a role that is allowed to move objects to the wastebasket

boolean FSCTEAMROOM@1.1001:HasRoomDeleteAccess(
  optional User user,
  out retval boolean hasdeleteaccess)

Name

Description

user

the user for whom the permission will be checked

hasdeleteaccess

the result