Package com.dropbox.core.v2.teamlog

Class TeamEvent

  • public class TeamEvent
extends java.lang.Object
    An audit log event.

    • Constructor Detail

      • TeamEvent

        public TeamEvent​(java.util.Date timestamp,
                 EventCategory eventCategory,
                 EventType eventType,
                 EventDetails details,
                 ActorLogInfo actor,
                 OriginLogInfo origin,
                 java.lang.Boolean involveNonTeamMember,
                 ContextLogInfo context,
                 java.util.List<ParticipantLogInfo> participants,
                 java.util.List<AssetLogInfo> assets)
        An audit log event.

        Use newBuilder(java.util.Date,com.dropbox.core.v2.teamlog.EventCategory,com.dropbox.core.v2.teamlog.EventType,com.dropbox.core.v2.teamlog.EventDetails) to create instances of this class without specifying values for all optional fields.

        Parameters:
        timestamp - The Dropbox timestamp representing when the action was taken. Must not be null.
        eventCategory - The category that this type of action belongs to. Must not be null.
        eventType - The particular type of action taken. Must not be null.
        details - The variable event schema applicable to this type of action, instantiated with respect to this particular action. Must not be null.
        actor - The entity who actually performed the action. Might be missing due to historical data gap.
        origin - The origin from which the actor performed the action including information about host, ip address, location, session, etc. If the action was performed programmatically via the API the origin represents the API client.
        involveNonTeamMember - True if the action involved a non team member either as the actor or as one of the affected users. Might be missing due to historical data gap.
        context - The user or team on whose behalf the actor performed the action. Might be missing due to historical data gap.
        participants - Zero or more users and/or groups that are affected by the action. Note that this list doesn't include any actors or users in context. Must not contain a null item.
        assets - Zero or more content assets involved in the action. Currently these include Dropbox files and folders but in the future we might add other asset types such as Paper documents, folders, projects, etc. Must not contain a null item.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

      • TeamEvent

        public TeamEvent​(java.util.Date timestamp,
                 EventCategory eventCategory,
                 EventType eventType,
                 EventDetails details)
        An audit log event.

        The default values for unset fields will be used.

        Parameters:
        timestamp - The Dropbox timestamp representing when the action was taken. Must not be null.
        eventCategory - The category that this type of action belongs to. Must not be null.
        eventType - The particular type of action taken. Must not be null.
        details - The variable event schema applicable to this type of action, instantiated with respect to this particular action. Must not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

    • Method Detail

      • getTimestamp

        public java.util.Date getTimestamp()
        The Dropbox timestamp representing when the action was taken.
        Returns:
        value for this field, never null.

      • getEventCategory

        public EventCategory getEventCategory()
        The category that this type of action belongs to.
        Returns:
        value for this field, never null.

      • getEventType

        public EventType getEventType()
        The particular type of action taken.
        Returns:
        value for this field, never null.

      • getDetails

        public EventDetails getDetails()
        The variable event schema applicable to this type of action, instantiated with respect to this particular action.
        Returns:
        value for this field, never null.

      • getActor

        public ActorLogInfo getActor()
        The entity who actually performed the action. Might be missing due to historical data gap.
        Returns:
        value for this field, or null if not present.

      • getOrigin

        public OriginLogInfo getOrigin()
        The origin from which the actor performed the action including information about host, ip address, location, session, etc. If the action was performed programmatically via the API the origin represents the API client.
        Returns:
        value for this field, or null if not present.

      • getInvolveNonTeamMember

        public java.lang.Boolean getInvolveNonTeamMember()
        True if the action involved a non team member either as the actor or as one of the affected users. Might be missing due to historical data gap.
        Returns:
        value for this field, or null if not present.

      • getContext

        public ContextLogInfo getContext()
        The user or team on whose behalf the actor performed the action. Might be missing due to historical data gap.
        Returns:
        value for this field, or null if not present.

      • getParticipants

        public java.util.List<ParticipantLogInfo> getParticipants()
        Zero or more users and/or groups that are affected by the action. Note that this list doesn't include any actors or users in context.
        Returns:
        value for this field, or null if not present.

      • getAssets

        public java.util.List<AssetLogInfo> getAssets()
        Zero or more content assets involved in the action. Currently these include Dropbox files and folders but in the future we might add other asset types such as Paper documents, folders, projects, etc.
        Returns:
        value for this field, or null if not present.

      • newBuilder

        public static TeamEvent.Builder newBuilder​(java.util.Date timestamp,
                                           EventCategory eventCategory,
                                           EventType eventType,
                                           EventDetails details)
        Returns a new builder for creating an instance of this class.
        Parameters:
        timestamp - The Dropbox timestamp representing when the action was taken. Must not be null.
        eventCategory - The category that this type of action belongs to. Must not be null.
        eventType - The particular type of action taken. Must not be null.
        details - The variable event schema applicable to this type of action, instantiated with respect to this particular action. Must not be null.
        Returns:
        builder for this class.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • toStringMultiline

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

        The returned String may contain newlines.

        Returns:
        Formatted, multiline String representation of this object