Package com.dropbox.core.v2.sharing

Class UserFileMembershipInfo

  • public class UserFileMembershipInfo
extends UserMembershipInfo
    The information about a user member of the shared content with an appended last seen timestamp.

    • Field Detail

      • timeLastSeen

        @Nullable
protected final java.util.Date timeLastSeen

      • platformType

        @Nullable
protected final PlatformType platformType

    • Constructor Detail

      • UserFileMembershipInfo

        public UserFileMembershipInfo​(@Nonnull
                              AccessLevel accessType,
                              @Nonnull
                              UserInfo user,
                              @Nullable
                              java.util.List<MemberPermission> permissions,
                              @Nullable
                              java.lang.String initials,
                              boolean isInherited,
                              @Nullable
                              java.util.Date timeLastSeen,
                              @Nullable
                              PlatformType platformType)
        The information about a user member of the shared content with an appended last seen timestamp.

        Use newBuilder(com.dropbox.core.v2.sharing.AccessLevel,com.dropbox.core.v2.sharing.UserInfo) to create instances of this class without specifying values for all optional fields.

        Parameters:
        accessType - The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder. Must not be null.
        user - The account information for the membership user. Must not be null.
        permissions - The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request. Must not contain a null item.
        initials - Never set.
        isInherited - True if the member has access from a parent folder.
        timeLastSeen - The UTC timestamp of when the user has last seen the content. Only populated if the user has seen the content and the caller has a plan that includes viewer history.
        platformType - The platform on which the user has last seen the content, or unknown.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

      • UserFileMembershipInfo

        public UserFileMembershipInfo​(@Nonnull
                              AccessLevel accessType,
                              @Nonnull
                              UserInfo user)
        The information about a user member of the shared content with an appended last seen timestamp.

        The default values for unset fields will be used.

        Parameters:
        accessType - The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder. Must not be null.
        user - The account information for the membership user. Must not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

    • Method Detail

      • getAccessType

        @Nonnull
public AccessLevel getAccessType()
        The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder.
        Overrides:
        getAccessType in class UserMembershipInfo
        Returns:
        value for this field, never null.

      • getUser

        @Nonnull
public UserInfo getUser()
        The account information for the membership user.
        Overrides:
        getUser in class UserMembershipInfo
        Returns:
        value for this field, never null.

      • getPermissions

        @Nullable
public java.util.List<MemberPermission> getPermissions()
        The permissions that requesting user has on this member. The set of permissions corresponds to the MemberActions in the request.
        Overrides:
        getPermissions in class UserMembershipInfo
        Returns:
        value for this field, or null if not present.

      • getInitials

        @Nullable
public java.lang.String getInitials()
        Never set.
        Overrides:
        getInitials in class UserMembershipInfo
        Returns:
        value for this field, or null if not present.

      • getIsInherited

        public boolean getIsInherited()
        True if the member has access from a parent folder.
        Overrides:
        getIsInherited in class UserMembershipInfo
        Returns:
        value for this field, or null if not present. Defaults to false.

      • getTimeLastSeen

        @Nullable
public java.util.Date getTimeLastSeen()
        The UTC timestamp of when the user has last seen the content. Only populated if the user has seen the content and the caller has a plan that includes viewer history.
        Returns:
        value for this field, or null if not present.

      • getPlatformType

        @Nullable
public PlatformType getPlatformType()
        The platform on which the user has last seen the content, or unknown.
        Returns:
        value for this field, or null if not present.

      • newBuilder

        public static UserFileMembershipInfo.Builder newBuilder​(AccessLevel accessType,
                                                        UserInfo user)
        Returns a new builder for creating an instance of this class.
        Parameters:
        accessType - The access type for this member. It contains inherited access type from parent folder, and acquired access type from this folder. Must not be null.
        user - The account information for the membership user. Must not be null.
        Returns:
        builder for this class.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

      • toStringMultiline

        public java.lang.String toStringMultiline()
        Returns a String representation of this object formatted for easier readability.

        The returned String may contain newlines.

        Overrides:
        toStringMultiline in class UserMembershipInfo
        Returns:
        Formatted, multiline String representation of this object