Class: Google::Apis::AdminDirectoryV1::Group

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/admin_directory_v1/classes.rb,
lib/google/apis/admin_directory_v1/representations.rb,
lib/google/apis/admin_directory_v1/representations.rb

Overview

Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the Developer's Guide.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Group

Returns a new instance of Group.



2241
2242
2243
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2241

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#admin_created ⇒ Boolean Also known as: admin_created?

Value is true if this group was created by an administrator rather than a user. Corresponds to the JSON property adminCreated

Returns:

  • (Boolean) 


2178
2179
2180
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2178

def admin_created
  @admin_created
end

#aliases ⇒ Array<String>

List of a group's alias email addresses. Corresponds to the JSON property aliases

Returns:

  • (Array<String>) 


2184
2185
2186
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2184

def aliases
  @aliases
end

#description ⇒ String

An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is 4,096 characters. Corresponds to the JSON property description

Returns:

  • (String) 


2192
2193
2194
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2192

def description
  @description
end

#direct_members_count ⇒ Fixnum

The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the directMembersCount property of the parent group. Corresponds to the JSON property directMembersCount

Returns:

  • (Fixnum) 


2199
2200
2201
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2199

def direct_members_count
  @direct_members_count
end

#email ⇒ String

The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The email must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the help center for details. Corresponds to the JSON property email

Returns:

  • (String) 


2208
2209
2210
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2208

def email
  @email
end

#etag ⇒ String

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String) 


2213
2214
2215
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2213

def etag
  @etag
end

#id ⇒ String

The unique ID of a group. A group id can be used as a group request URI's groupKey. Corresponds to the JSON property id

Returns:

  • (String) 


2219
2220
2221
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2219

def id
  @id
end

#kind ⇒ String

The type of the API resource. For Groups resources, the value is admin# directory#group. Corresponds to the JSON property kind

Returns:

  • (String) 


2225
2226
2227
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2225

def kind
  @kind
end

#name ⇒ String

The group's display name. Corresponds to the JSON property name

Returns:

  • (String) 


2230
2231
2232
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2230

def name
  @name
end

#non_editable_aliases ⇒ Array<String>

List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service. Corresponds to the JSON property nonEditableAliases

Returns:

  • (Array<String>) 


2239
2240
2241
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2239

def non_editable_aliases
  @non_editable_aliases
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2246

def update!(**args)
  @admin_created = args[:admin_created] if args.key?(:admin_created)
  @aliases = args[:aliases] if args.key?(:aliases)
  @description = args[:description] if args.key?(:description)
  @direct_members_count = args[:direct_members_count] if args.key?(:direct_members_count)
  @email = args[:email] if args.key?(:email)
  @etag = args[:etag] if args.key?(:etag)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @non_editable_aliases = args[:non_editable_aliases] if args.key?(:non_editable_aliases)
end