Interface IAnyFolder

All Known Implementing Classes:
AnyFolder

public interface IAnyFolder
The Interface IAnyFolder to get, update and create folder.
  • Method Details

    • getId

      String getId()
      Gets identifier of the folder.
      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 folder global unique identifier
    • getParentId

      String getParentId()
      Gets the parent identifier. Can be a folder identifier or a room identifier if you are at the top level of the folder tree.
      Returns:
      the parent id
    • setParentId

      void setParentId(String parentId)
      Sets the parent identifier.

      Not used when you create or update. It is only for internal use by the API. Can be a folder identifier or a room identifier if you are at the top level of the folder tree.

      Parameters:
      parentId - the new parent identifier
    • isAllowEdit

      boolean isAllowEdit()
      Checks if the folder allows edit for current user.
      Returns:
      true, if current user can edit
    • setAllowEdit

      void setAllowEdit(boolean allowEdit)
      Sets the allow edit value. Only for internal use by the API, you cannot set it in Any with the API.
      Parameters:
      allowEdit - the new allow edit value
    • hasSecurityOverwrite

      boolean hasSecurityOverwrite()
      Checks if the folder has security overwrite
      Returns:
      true, if folder has security overwrite
    • setSecurityOverwrite

      void setSecurityOverwrite(boolean overwrite)
      Sets the security overwrite value.
      Parameters:
      overwrite - the new allow edit value
    • getContributors

      List<ApiMember> getContributors()
      Gets folder contributors list if security is overwritten.
      Returns:
      List of members. Each member can be a group or user.
    • setContributors

      void setContributors(List<ApiMember> members)
      Sets the list of contributors members. Only used if security is overwritten.
      Parameters:
      members - the new list of user/group members.
    • getName

      String getName()
      Gets the folder name.
      Returns:
      the folder name used in folder path
    • setName

      void setName(String name)
      Sets the folder name.

      You must distinguish the folder name and the folder titles. Folder titles are the nice localized labels displayed in Any and the folder name is used to build unique folder path into the room.

      Parameters:
      name - the new name
    • setTitles

      void setTitles(Map<Locale,String> titles)
      Sets the folder 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