Interface IAnyRoom

All Known Implementing Classes:
AnyRoom

public interface IAnyRoom
The Interface IAnyRoom to get, update and create room.
  • Method Details

    • getId

      String getId()
      Gets identifier of the room.
      Returns:
      the identifier. When you get the object from the server the identifier is the global unique identifier.
    • setId

      void setId(String id)
      Sets the identifier of the folder. Not used when you create or update. It is only for internal use by the API.
      Parameters:
      id - the room global unique identifier
    • getName

      String getName()
      Gets the room name.
      Returns:
      the room name
    • setName

      void setName(String name)
      Sets the room name.

      Required when you create a new room. It must only contains letters and numbers in lower case, no special characters are accepted.

      Parameters:
      name - the new name
    • getBrowsingMode

      String getBrowsingMode()
      Gets the browsing mode.
      Returns:
      the browsing mode ("flat", "folders" or "mixed")
    • setBrowsingMode

      void setBrowsingMode(String mode)
      Sets the browsing mode.
      Parameters:
      mode - the new browsing mode ("flat", "folders" or "mixed")
    • getViewers

      List<ApiMember> getViewers()
      Gets the viewers. Viewers are user allowed to see the room but cannot browse them until access request is accepted.
      Returns:
      the viewers
    • setViewers

      void setViewers(List<ApiMember> members)
      Sets the viewers. Viewers are user allowed to see the room but cannot browse them until access request is accepted.
      Parameters:
      members - the new viewers. Each member can be a group or a user.
    • getContributors

      List<ApiMember> getContributors()
      Gets the contributors.
      Returns:
      the members of contributors
    • setContributors

      void setContributors(List<ApiMember> members)
      Sets the contributors.
      Parameters:
      members - the new contributors. Each member can be a group or a user.
    • getReaders

      List<ApiMember> getReaders()
      Gets the readers.
      Returns:
      the members of readers
    • setReaders

      void setReaders(List<ApiMember> members)
      Sets the readers.
      Parameters:
      members - the new readers. Each member can be a group or a user.
    • getAdministrators

      List<ApiMember> getAdministrators()
      Gets the administrators.
      Returns:
      the members of administrators
    • setAdministrators

      void setAdministrators(List<ApiMember> members)
      Sets the administrators.
      Parameters:
      members - the new administrators. Each member can be a group or a user.
    • setTitles

      void setTitles(Map<Locale,String> titles)
      Sets the room localized titles displayed in Any.
       Example
       
      Parameters:
      titles - the localized titles
    • setDescriptions

      void setDescriptions(Map<Locale,String> descriptions)
      Sets the localized descriptions.
      Parameters:
      descriptions - the localized descriptions
    • setCollections

      void setCollections(List<String> list)
      Sets the collections used in the room.
      Parameters:
      list - the new collections
    • setVersion

      void setVersion(String version)
      Sets the version of contents displayed in the room.

      Do not set it if you want to display all versions. Use "latest" value if you want to only display latest versions.

      Parameters:
      version - the new version to use
    • setControlledView

      void setControlledView(String controlledConfig)
      Sets the controlled view configuration to use in the room if you want to drive configuration at room level.
      Parameters:
      controlledConfig - the new controlled view configuration to use
    • setControlledPrint

      void setControlledPrint(String controlledConfig)
      Sets the controlled print configuration to use in the room if you want to drive configuration at room level.
      Parameters:
      controlledConfig - the new controlled print configuration to use
    • setControlledExport

      void setControlledExport(String controlledConfig)
      Sets the controlled export configuration to use in the room if you want to drive configuration at room level.
      Parameters:
      controlledConfig - the new controlled export configuration to use
    • setColorization

      void setColorization(String colorization)
      Sets the colorization configuration to use in the room if you want to drive configuration at room level.
      Parameters:
      colorization - the new colorization configuration to use
    • setViewsConfig

      void setViewsConfig(List<IView> views)
      Sets the views to use in the room.

      Only compatible with browsing mode IApiRoomConstants.BROWSING_MODE_VIEWS or IApiRoomConstants.BROWSING_MODE_MIXED

      Parameters:
      views - the new views config
    • setMassupdateMetadata

      void setMassupdateMetadata(List<String> metadata)
      Sets the metadata list you can update with mass update feature.
      Parameters:
      metadata - the new mass update metadata list
    • setReadersPermissions

      void setReadersPermissions(List<String> permissions)
      Sets the additional readers ACL permissions in the room.
      Parameters:
      permissions - the new readers permissions. Possible values are "content:change_state", "content:properties:edit" or "content:comment:*"
    • setImgResourceId

      void setImgResourceId(String imgresourceid)
      Sets the image resource identifier used to display room.
      Parameters:
      imgresourceid - the new image resource identifier. Image resource must refer to an existing room image imported in Any.
    • setColumns

      void setColumns(String type, List<ApiColumn> columns)
      Sets the columns to use in the room for main contents or relations.
      Parameters:
      type - the type. Possible values are "main" or "relations".
      columns - the columns
    • setRssFeedEnabled

      void setRssFeedEnabled(boolean enabled)
      Sets the RSS feed enabled value.
      Parameters:
      enabled - the new RSS feed enabled value.
    • setOnlyVerifiedContentsAllowed

      void setOnlyVerifiedContentsAllowed(boolean enabled)
      Sets the only verified contents allowed value. When only verified content is allowed any content linked or created in the room must match a least a collection of the room.
      Parameters:
      enabled - the new only verified contents allowed value
    • setStaticLinkForbidden

      void setStaticLinkForbidden(boolean enabled)
      Sets the static link forbidden value. When static link is forbidden you cannot manually add a content to the room.
      Parameters:
      enabled - the new static link forbidden value