You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::WorkDocs::Types::Activity

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb

Overview

Describes the activity information.

Instance Attribute Summary collapse

Instance Attribute Details

#comment_metadataTypes::CommentMetadata

Metadata of the commenting activity. This is an optional field and is filled for commenting activities.



129
130
131
132
133
134
135
136
137
138
139
140
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 129

class Activity < Struct.new(
  :type,
  :time_stamp,
  :is_indirect_activity,
  :organization_id,
  :initiator,
  :participants,
  :resource_metadata,
  :original_parent,
  :comment_metadata)
  include Aws::Structure
end

#initiatorTypes::UserMetadata

The user who performed the action.

Returns:



129
130
131
132
133
134
135
136
137
138
139
140
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 129

class Activity < Struct.new(
  :type,
  :time_stamp,
  :is_indirect_activity,
  :organization_id,
  :initiator,
  :participants,
  :resource_metadata,
  :original_parent,
  :comment_metadata)
  include Aws::Structure
end

#is_indirect_activityBoolean

Indicates whether an activity is indirect or direct. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).

Returns:

  • (Boolean)


129
130
131
132
133
134
135
136
137
138
139
140
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 129

class Activity < Struct.new(
  :type,
  :time_stamp,
  :is_indirect_activity,
  :organization_id,
  :initiator,
  :participants,
  :resource_metadata,
  :original_parent,
  :comment_metadata)
  include Aws::Structure
end

#organization_idString

The ID of the organization.

Returns:

  • (String)


129
130
131
132
133
134
135
136
137
138
139
140
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 129

class Activity < Struct.new(
  :type,
  :time_stamp,
  :is_indirect_activity,
  :organization_id,
  :initiator,
  :participants,
  :resource_metadata,
  :original_parent,
  :comment_metadata)
  include Aws::Structure
end

#original_parentTypes::ResourceMetadata

The original parent of the resource. This is an optional field and is filled for move activities.



129
130
131
132
133
134
135
136
137
138
139
140
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 129

class Activity < Struct.new(
  :type,
  :time_stamp,
  :is_indirect_activity,
  :organization_id,
  :initiator,
  :participants,
  :resource_metadata,
  :original_parent,
  :comment_metadata)
  include Aws::Structure
end

#participantsTypes::Participants

The list of users or groups impacted by this action. This is an optional field and is filled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.

Returns:



129
130
131
132
133
134
135
136
137
138
139
140
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 129

class Activity < Struct.new(
  :type,
  :time_stamp,
  :is_indirect_activity,
  :organization_id,
  :initiator,
  :participants,
  :resource_metadata,
  :original_parent,
  :comment_metadata)
  include Aws::Structure
end

#resource_metadataTypes::ResourceMetadata

The metadata of the resource involved in the user action.



129
130
131
132
133
134
135
136
137
138
139
140
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 129

class Activity < Struct.new(
  :type,
  :time_stamp,
  :is_indirect_activity,
  :organization_id,
  :initiator,
  :participants,
  :resource_metadata,
  :original_parent,
  :comment_metadata)
  include Aws::Structure
end

#time_stampTime

The timestamp when the action was performed.

Returns:

  • (Time)


129
130
131
132
133
134
135
136
137
138
139
140
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 129

class Activity < Struct.new(
  :type,
  :time_stamp,
  :is_indirect_activity,
  :organization_id,
  :initiator,
  :participants,
  :resource_metadata,
  :original_parent,
  :comment_metadata)
  include Aws::Structure
end

#typeString

The activity type.

Returns:

  • (String)


129
130
131
132
133
134
135
136
137
138
139
140
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 129

class Activity < Struct.new(
  :type,
  :time_stamp,
  :is_indirect_activity,
  :organization_id,
  :initiator,
  :participants,
  :resource_metadata,
  :original_parent,
  :comment_metadata)
  include Aws::Structure
end