Class: GroupDocs::User
Constant Summary
Api::Helpers::AccessRights::ACCESS_RIGHTS
Instance Attribute Summary collapse
Class Method Summary
collapse
-
.area!(embed_key, access = {}) ⇒ String
Get area name by embed key.
-
.claimed_token!(caller_id, options = {}, access = {}) ⇒ String
Get user profile by claimed token.
-
.create_login!(caller_id, options = {}, access = {}) ⇒ GroupDocs::User
-
.delete!(user, access = {}) ⇒ String
-
.download!(path, name, guid, options = {}) ⇒ Object
Logins user using user name and password.
-
.generate_embed_key!(area, access = {}) ⇒ String
Generates new user embed key.
-
.get!(access = {}) ⇒ GroupDocs::User
Returns current user profile.
-
.get_account!(access = {}) ⇒ Array
Returns an account information.
-
.get_embed_key!(area, access = {}) ⇒ String
-
.get_html!(path, name, guid) ⇒ Object
-
.get_profile!(caller_id, access = {}) ⇒ String
-
.get_xml!(path, name, guid) ⇒ Object
-
.login!(email, password) ⇒ GroupDocs::User
Logins user using user name and password.
-
.providers!(access = {}) ⇒ Array<GroupDocs::Storage::Provider>
Returns an array of storage providers.
-
.remove_account!(access = {}) ⇒ String
-
.reset_alien_password!(caller_id, access = {}) ⇒ Object
Change alien user password.
-
.reset_token!(caller_id, options = {}, access = {}) ⇒ String
Get user profile by reset token.
-
.revoke!(access = {}) ⇒ Object
-
.set_user_roles!(caller_id, role_info = {}, access = {}) ⇒ Array
-
.update_account!(user, access = {}) ⇒ GroupDocs::User
Updates user account if it’s created, otherwise creates new.
-
.update_alien_password!(caller_id, pas_info = {}, access = {}) ⇒ Object
Change alien user password.
-
.update_password!(pas_info = {}, access = {}) ⇒ Object
-
.user_roles!(caller_id, access = {}) ⇒ Array
Returns an array of roles.
-
.verif_token!(caller_id, options = {}, access = {}) ⇒ String
Get user profile by reset token.
Instance Method Summary
collapse
#array_from_byte, #byte_from_array
Methods inherited from Api::Entity
#initialize, #inspect, #to_hash
#alias_accessor
Instance Attribute Details
#active ⇒ Object
370
371
372
|
# File 'lib/groupdocs/user.rb', line 370
def active
@active
end
|
#alerts_eanbled ⇒ Object
392
393
394
|
# File 'lib/groupdocs/user.rb', line 392
def alerts_eanbled
@alerts_eanbled
end
|
#annotation_background_color ⇒ Object
454
455
456
|
# File 'lib/groupdocs/user.rb', line 454
def annotation_background_color
@annotation_background_color
end
|
#annotation_branded ⇒ Object
400
401
402
|
# File 'lib/groupdocs/user.rb', line 400
def annotation_branded
@annotation_branded
end
|
414
415
416
|
# File 'lib/groupdocs/user.rb', line 414
def
@annotation_header_options
end
|
#annotation_logo ⇒ Object
410
411
412
|
# File 'lib/groupdocs/user.rb', line 410
def annotation_logo
@annotation_logo
end
|
#annotation_navigation_icons ⇒ Object
450
451
452
|
# File 'lib/groupdocs/user.rb', line 450
def annotation_navigation_icons
@annotation_navigation_icons
end
|
452
453
454
|
# File 'lib/groupdocs/user.rb', line 452
def annotation_tool_icons
@annotation_tool_icons
end
|
#apps ⇒ Object
398
399
400
|
# File 'lib/groupdocs/user.rb', line 398
def apps
@apps
end
|
#avatar ⇒ Object
384
385
386
|
# File 'lib/groupdocs/user.rb', line 384
def avatar
@avatar
end
|
#claimed_id ⇒ Object
362
363
364
|
# File 'lib/groupdocs/user.rb', line 362
def claimed_id
@claimed_id
end
|
#color ⇒ Object
376
377
378
|
# File 'lib/groupdocs/user.rb', line 376
def color
@color
end
|
#customEmailMessage ⇒ Object
378
379
380
|
# File 'lib/groupdocs/user.rb', line 378
def customEmailMessage
@customEmailMessage
end
|
#firstname ⇒ Object
352
353
354
|
# File 'lib/groupdocs/user.rb', line 352
def firstname
@firstname
end
|
#guid ⇒ Object
348
349
350
|
# File 'lib/groupdocs/user.rb', line 348
def guid
@guid
end
|
#id ⇒ Object
346
347
348
|
# File 'lib/groupdocs/user.rb', line 346
def id
@id
end
|
#is_annotation_document_name_shown ⇒ Object
448
449
450
|
# File 'lib/groupdocs/user.rb', line 448
def is_annotation_document_name_shown
@is_annotation_document_name_shown
end
|
420
421
422
|
# File 'lib/groupdocs/user.rb', line 420
def is_annotation_download_widget_enabled
@is_annotation_download_widget_enabled
end
|
424
425
426
|
# File 'lib/groupdocs/user.rb', line 424
def is_annotation_help_widget_enabled
@is_annotation_help_widget_enabled
end
|
416
417
418
|
# File 'lib/groupdocs/user.rb', line 416
def is_annotation_navigation_widget_enabled
@is_annotation_navigation_widget_enabled
end
|
422
423
424
|
# File 'lib/groupdocs/user.rb', line 422
def is_annotation_print_widget_enabled
@is_annotation_print_widget_enabled
end
|
418
419
420
|
# File 'lib/groupdocs/user.rb', line 418
def is_annotation_zoom_widget_enabled
@is_annotation_zoom_widget_enabled
end
|
536
537
538
|
# File 'lib/groupdocs/user.rb', line 536
def is_arrow_annotation_button_enabled
@is_arrow_annotation_button_enabled
end
|
544
545
546
|
# File 'lib/groupdocs/user.rb', line 544
def is_distance_annotation_button_enabled
@is_distance_annotation_button_enabled
end
|
438
439
440
|
# File 'lib/groupdocs/user.rb', line 438
def is_point_annotation_button_enabled
@is_point_annotation_button_enabled
end
|
442
443
444
|
# File 'lib/groupdocs/user.rb', line 442
def is_polyline_annotation_button_enabled
@is_polyline_annotation_button_enabled
end
|
#is_real_time_broadcast_enabled ⇒ Object
404
405
406
|
# File 'lib/groupdocs/user.rb', line 404
def is_real_time_broadcast_enabled
@is_real_time_broadcast_enabled
end
|
436
437
438
|
# File 'lib/groupdocs/user.rb', line 436
def is_rectangle_annotation_button_enabled
@is_rectangle_annotation_button_enabled
end
|
540
541
542
|
# File 'lib/groupdocs/user.rb', line 540
def is_resource_redaction_annotation_button_enabled
@is_resource_redaction_annotation_button_enabled
end
|
#is_right_panel_enabled ⇒ Object
426
427
428
|
# File 'lib/groupdocs/user.rb', line 426
def is_right_panel_enabled
@is_right_panel_enabled
end
|
406
407
408
|
# File 'lib/groupdocs/user.rb', line 406
def is_scroll_broadcast_enabled
@is_scroll_broadcast_enabled
end
|
#is_standard_header_always_shown ⇒ Object
430
431
432
|
# File 'lib/groupdocs/user.rb', line 430
def is_standard_header_always_shown
@is_standard_header_always_shown
end
|
440
441
442
|
# File 'lib/groupdocs/user.rb', line 440
def is_strikeout_annotation_button_enabled
@is_strikeout_annotation_button_enabled
end
|
#is_text_annotation_button_enabled ⇒ Object
434
435
436
|
# File 'lib/groupdocs/user.rb', line 434
def is_text_annotation_button_enabled
@is_text_annotation_button_enabled
end
|
#is_text_redaction_annotation_button_enabled ⇒ Object
538
539
540
|
# File 'lib/groupdocs/user.rb', line 538
def is_text_redaction_annotation_button_enabled
@is_text_redaction_annotation_button_enabled
end
|
#is_text_replacement_annotation_button_enabled ⇒ Object
534
535
536
|
# File 'lib/groupdocs/user.rb', line 534
def is_text_replacement_annotation_button_enabled
@is_text_replacement_annotation_button_enabled
end
|
#is_text_underline_annotation_button_enabled ⇒ Object
542
543
544
|
# File 'lib/groupdocs/user.rb', line 542
def is_text_underline_annotation_button_enabled
@is_text_underline_annotation_button_enabled
end
|
#is_thumbnails_panel_enabled ⇒ Object
428
429
430
|
# File 'lib/groupdocs/user.rb', line 428
def is_thumbnails_panel_enabled
@is_thumbnails_panel_enabled
end
|
432
433
434
|
# File 'lib/groupdocs/user.rb', line 432
def is_toolbar_enabled
@is_toolbar_enabled
end
|
444
445
446
|
# File 'lib/groupdocs/user.rb', line 444
def is_typewriter_annotation_button_enabled
@is_typewriter_annotation_button_enabled
end
|
#is_viewer_document_name_shown ⇒ Object
470
471
472
|
# File 'lib/groupdocs/user.rb', line 470
def is_viewer_document_name_shown
@is_viewer_document_name_shown
end
|
464
465
466
|
# File 'lib/groupdocs/user.rb', line 464
def is_viewer_download_widget_enabled
@is_viewer_download_widget_enabled
end
|
468
469
470
|
# File 'lib/groupdocs/user.rb', line 468
def is_viewer_help_widget_enabled
@is_viewer_help_widget_enabled
end
|
460
461
462
|
# File 'lib/groupdocs/user.rb', line 460
def is_viewer_navigation_widget_enabled
@is_viewer_navigation_widget_enabled
end
|
466
467
468
|
# File 'lib/groupdocs/user.rb', line 466
def is_viewer_print_widget_enabled
@is_viewer_print_widget_enabled
end
|
462
463
464
|
# File 'lib/groupdocs/user.rb', line 462
def is_viewer_zoom_widget_enabled
@is_viewer_zoom_widget_enabled
end
|
446
447
448
|
# File 'lib/groupdocs/user.rb', line 446
def is_watermark_annotation_button_enabled
@is_watermark_annotation_button_enabled
end
|
#is_zoom_broadcast_enabled ⇒ Object
408
409
410
|
# File 'lib/groupdocs/user.rb', line 408
def is_zoom_broadcast_enabled
@is_zoom_broadcast_enabled
end
|
472
473
474
|
# File 'lib/groupdocs/user.rb', line 472
def
@isviewer_right_mouse_button_menu_enabled
end
|
#lastname ⇒ Object
354
355
356
|
# File 'lib/groupdocs/user.rb', line 354
def lastname
@lastname
end
|
#news_eanbled ⇒ Object
390
391
392
|
# File 'lib/groupdocs/user.rb', line 390
def news_eanbled
@news_eanbled
end
|
#news_enabled ⇒ Object
372
373
374
|
# File 'lib/groupdocs/user.rb', line 372
def news_enabled
@news_enabled
end
|
#nickname ⇒ Object
350
351
352
|
# File 'lib/groupdocs/user.rb', line 350
def nickname
@nickname
end
|
#password_salt ⇒ Object
360
361
362
|
# File 'lib/groupdocs/user.rb', line 360
def password_salt
@password_salt
end
|
#photo ⇒ Object
368
369
370
|
# File 'lib/groupdocs/user.rb', line 368
def photo
@photo
end
|
412
413
414
|
# File 'lib/groupdocs/user.rb', line 412
def pointer_tool_cursor
@pointer_tool_cursor
end
|
#primary_email ⇒ Object
356
357
358
|
# File 'lib/groupdocs/user.rb', line 356
def primary_email
@primary_email
end
|
#private_key ⇒ Object
358
359
360
|
# File 'lib/groupdocs/user.rb', line 358
def private_key
@private_key
end
|
#roles ⇒ Object
380
381
382
|
# File 'lib/groupdocs/user.rb', line 380
def roles
@roles
end
|
#signature_color ⇒ Object
486
487
488
|
# File 'lib/groupdocs/user.rb', line 486
def signature_color
@signature_color
end
|
#signature_desktop_notifications ⇒ Object
480
481
482
|
# File 'lib/groupdocs/user.rb', line 480
def signature_desktop_notifications
@signature_desktop_notifications
end
|
528
529
530
|
# File 'lib/groupdocs/user.rb', line 528
def
@signature_enable_envelope_comment
end
|
530
531
532
|
# File 'lib/groupdocs/user.rb', line 530
def
@signature_enable_form_comment
end
|
#signature_enable_typed_signature ⇒ Object
526
527
528
|
# File 'lib/groupdocs/user.rb', line 526
def signature_enable_typed_signature
@signature_enable_typed_signature
end
|
#signature_enable_uploaded_signature ⇒ Object
524
525
526
|
# File 'lib/groupdocs/user.rb', line 524
def signature_enable_uploaded_signature
@signature_enable_uploaded_signature
end
|
#signature_envelope_cancelled_template ⇒ Object
504
505
506
|
# File 'lib/groupdocs/user.rb', line 504
def signature_envelope_cancelled_template
@signature_envelope_cancelled_template
end
|
#signature_envelope_completed_template ⇒ Object
496
497
498
|
# File 'lib/groupdocs/user.rb', line 496
def signature_envelope_completed_template
@signature_envelope_completed_template
end
|
#signature_envelope_declined_template ⇒ Object
500
501
502
|
# File 'lib/groupdocs/user.rb', line 500
def signature_envelope_declined_template
@signature_envelope_declined_template
end
|
#signature_envelope_expired_template ⇒ Object
506
507
508
|
# File 'lib/groupdocs/user.rb', line 506
def signature_envelope_expired_template
@signature_envelope_expired_template
end
|
#signature_envelope_failed_template ⇒ Object
502
503
504
|
# File 'lib/groupdocs/user.rb', line 502
def signature_envelope_failed_template
@signature_envelope_failed_template
end
|
#signature_envelope_recipient_reminder_template ⇒ Object
510
511
512
|
# File 'lib/groupdocs/user.rb', line 510
def signature_envelope_recipient_reminder_template
@signature_envelope_recipient_reminder_template
end
|
#signature_envelope_request_user_auth_by_photo ⇒ Object
522
523
524
|
# File 'lib/groupdocs/user.rb', line 522
def signature_envelope_request_user_auth_by_photo
@signature_envelope_request_user_auth_by_photo
end
|
#signature_envelope_require_user_auth_for_sign ⇒ Object
520
521
522
|
# File 'lib/groupdocs/user.rb', line 520
def signature_envelope_require_user_auth_for_sign
@signature_envelope_require_user_auth_for_sign
end
|
#signature_envelope_sent_other_template ⇒ Object
494
495
496
|
# File 'lib/groupdocs/user.rb', line 494
def signature_envelope_sent_other_template
@signature_envelope_sent_other_template
end
|
#signature_envelope_sent_owner_template ⇒ Object
492
493
494
|
# File 'lib/groupdocs/user.rb', line 492
def signature_envelope_sent_owner_template
@signature_envelope_sent_owner_template
end
|
#signature_envelope_signed_template ⇒ Object
498
499
500
|
# File 'lib/groupdocs/user.rb', line 498
def signature_envelope_signed_template
@signature_envelope_signed_template
end
|
#signature_envelope_step_expired_template ⇒ Object
508
509
510
|
# File 'lib/groupdocs/user.rb', line 508
def signature_envelope_step_expired_template
@signature_envelope_step_expired_template
end
|
516
517
518
|
# File 'lib/groupdocs/user.rb', line 516
def signature_form_request_user_auth_by_photo
@signature_form_request_user_auth_by_photo
end
|
514
515
516
|
# File 'lib/groupdocs/user.rb', line 514
def signature_form_require_user_auth_for_sign
@signature_form_require_user_auth_for_sign
end
|
518
519
520
|
# File 'lib/groupdocs/user.rb', line 518
def signature_form_require_user_identity_validation
@signature_form_require_user_identity_validation
end
|
512
513
514
|
# File 'lib/groupdocs/user.rb', line 512
def signature_form_signed_template
@signature_form_signed_template
end
|
#signature_save_field_changes_automatically ⇒ Object
488
489
490
|
# File 'lib/groupdocs/user.rb', line 488
def signature_save_field_changes_automatically
@signature_save_field_changes_automatically
end
|
#signature_use_custom_email_templates ⇒ Object
490
491
492
|
# File 'lib/groupdocs/user.rb', line 490
def signature_use_custom_email_templates
@signature_use_custom_email_templates
end
|
#signature_watermark_enabled ⇒ Object
478
479
480
|
# File 'lib/groupdocs/user.rb', line 478
def signature_watermark_enabled
@signature_watermark_enabled
end
|
#signed_up_on ⇒ Time
Converts timestamp which is return by API server to Time object.
374
375
376
|
# File 'lib/groupdocs/user.rb', line 374
def signed_up_on
@signed_up_on
end
|
#signedinOn ⇒ Object
474
475
476
|
# File 'lib/groupdocs/user.rb', line 474
def signedinOn
@signedinOn
end
|
#signin_count ⇒ Object
476
477
478
|
# File 'lib/groupdocs/user.rb', line 476
def signin_count
@signin_count
end
|
#storage ⇒ Object
366
367
368
|
# File 'lib/groupdocs/user.rb', line 366
def storage
@storage
end
|
#support_eanbled ⇒ Object
394
395
396
|
# File 'lib/groupdocs/user.rb', line 394
def support_eanbled
@support_eanbled
end
|
#support_email ⇒ Object
396
397
398
|
# File 'lib/groupdocs/user.rb', line 396
def support_email
@support_email
end
|
#token ⇒ Object
364
365
366
|
# File 'lib/groupdocs/user.rb', line 364
def token
@token
end
|
#trial ⇒ Object
388
389
390
|
# File 'lib/groupdocs/user.rb', line 388
def trial
@trial
end
|
#viewer_branded ⇒ Object
402
403
404
|
# File 'lib/groupdocs/user.rb', line 402
def viewer_branded
@viewer_branded
end
|
#viewer_logo ⇒ Object
456
457
458
|
# File 'lib/groupdocs/user.rb', line 456
def viewer_logo
@viewer_logo
end
|
#viewer_options ⇒ Object
458
459
460
|
# File 'lib/groupdocs/user.rb', line 458
def viewer_options
@viewer_options
end
|
#webhook_notification_failed_recipients ⇒ Object
484
485
486
|
# File 'lib/groupdocs/user.rb', line 484
def webhook_notification_failed_recipients
@webhook_notification_failed_recipients
end
|
#webhook_notification_retries ⇒ Object
482
483
484
|
# File 'lib/groupdocs/user.rb', line 482
def webhook_notification_retries
@webhook_notification_retries
end
|
Class Method Details
.area!(embed_key, access = {}) ⇒ String
Get area name by embed key.
151
152
153
154
155
156
157
158
159
|
# File 'lib/groupdocs/user.rb', line 151
def self.area!(embed_key, access = {})
json = Api::Request.new do |request|
request[:access] = access
request[:method] = :GET
request[:path] = "/mgmt/{{client_id}}/embedkey/guid/#{embed_key}"
end.execute!
json[:key][:area]
end
|
.claimed_token!(caller_id, options = {}, access = {}) ⇒ String
Get user profile by claimed token
705
706
707
708
709
710
711
712
713
714
|
# File 'lib/groupdocs/user.rb', line 705
def self.claimed_token!(caller_id, options ={}, access = {})
api = Api::Request.new do |request|
request[:access] = access
request[:method] = :GET
request[:path] = "/mgmt/#{caller_id}/claimed-tokens"
end
api.add_params(options)
api.execute!
end
|
.create_login!(caller_id, options = {}, access = {}) ⇒ GroupDocs::User
785
786
787
788
789
790
791
792
793
794
|
# File 'lib/groupdocs/user.rb', line 785
def self.create_login!(caller_id, options = {}, access = {})
api = Api::Request.new do |request|
request[:access] = access
request[:method] = :POST
request[:path] = "/mgmt/#{caller_id}/user/{{client_id}}/logins"
end
api.add_params(options)
api.execute!
end
|
.delete!(user, access = {}) ⇒ String
79
80
81
82
83
84
85
86
87
88
89
90
|
# File 'lib/groupdocs/user.rb', line 79
def self.delete!(user, access = {})
user.is_a?(GroupDocs::User) or raise ArgumentError,
"User should be GroupDocs::User object, received: #{user.inspect}"
json = Api::Request.new do |request|
request[:access] = access
request[:method] = :DELETE
request[:path] = "/mgmt/{{client_id}}/account/users/#{user.primary_email}"
end.execute!
json[:guid]
end
|
.download!(path, name, guid, options = {}) ⇒ Object
Logins user using user name and password.
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
|
# File 'lib/groupdocs/user.rb', line 269
def self.download!(path, name, guid, options = {})
api = Api::Request.new do |request|
request[:sign] = false
request[:method] = :DOWNLOAD
request[:path] = "/shared/files/#{guid}"
end
api.add_params(options)
response = api.execute!
filepath = "#{path}/#{name}"
Object::File.open(filepath, 'wb') do |file|
file.write(response)
end
filepath
end
|
.generate_embed_key!(area, access = {}) ⇒ String
Generates new user embed key.
105
106
107
108
109
110
111
112
113
|
# File 'lib/groupdocs/user.rb', line 105
def self.generate_embed_key!(area, access = {})
json = Api::Request.new do |request|
request[:access] = access
request[:method] = :GET
request[:path] = "/mgmt/{{client_id}}/embedkey/new/#{area}"
end.execute!
json[:key][:guid]
end
|
Returns current user profile.
19
20
21
22
23
24
25
26
27
|
# File 'lib/groupdocs/user.rb', line 19
def self.get!(access = {})
json = Api::Request.new do |request|
request[:access] = access
request[:method] = :GET
request[:path] = '/mgmt/{{client_id}}/profile'
end.execute!
new(json[:user])
end
|
.get_account!(access = {}) ⇒ Array
Returns an account information
905
906
907
908
909
910
911
|
# File 'lib/groupdocs/user.rb', line 905
def self.get_account!(access = {})
Api::Request.new do |request|
request[:access] = access
request[:method] = :GET
request[:path] = "/mgmt/{{client_id}}/account"
end.execute!
end
|
.get_embed_key!(area, access = {}) ⇒ String
Get user embed key. Generate new embed key if area not exists.
128
129
130
131
132
133
134
135
136
|
# File 'lib/groupdocs/user.rb', line 128
def self.get_embed_key!(area, access = {})
json = Api::Request.new do |request|
request[:access] = access
request[:method] = :GET
request[:path] = "/mgmt/{{client_id}}/embedkey/#{area}"
end.execute!
json[:key][:guid]
end
|
.get_html!(path, name, guid) ⇒ Object
311
312
313
314
315
316
317
318
319
320
321
322
323
324
|
# File 'lib/groupdocs/user.rb', line 311
def self.get_html!(path, name, guid)
response = Api::Request.new do |request|
request[:sign] = false
request[:method] = :DOWNLOAD
request[:path] = "/shared/files/#{guid}/html"
end.execute!
filepath = "#{path}/#{name}"
Object::File.open(filepath, 'wb') do |file|
file.write(response)
end
filepath
end
|
.get_profile!(caller_id, access = {}) ⇒ String
725
726
727
728
729
730
731
732
733
|
# File 'lib/groupdocs/user.rb', line 725
def self.get_profile!(caller_id, access = {})
json = Api::Request.new do |request|
request[:access] = access
request[:method] = :GET
request[:path] = "/mgmt/#{caller_id}/user/{{client_id}}/profile"
end.execute!
json[:user]
end
|
.get_xml!(path, name, guid) ⇒ Object
291
292
293
294
295
296
297
298
299
300
301
302
303
304
|
# File 'lib/groupdocs/user.rb', line 291
def self.get_xml!(path, name, guid)
response = Api::Request.new do |request|
request[:sign] = false
request[:method] = :DOWNLOAD
request[:path] = "/shared/files/#{guid}/xml"
end.execute!
filepath = "#{path}/#{name}"
Object::File.open(filepath, 'wb') do |file|
file.write(response)
end
filepath
end
|
Logins user using user name and password.
250
251
252
253
254
255
256
257
258
259
|
# File 'lib/groupdocs/user.rb', line 250
def self.login!(email, password)
json = Api::Request.new do |request|
request[:sign] = false
request[:method] = :POST
request[:path] = "/shared/users/#{email}/logins"
request[:request_body] = password
end.execute!
new(json[:user])
end
|
Returns an array of storage providers.
174
175
176
177
178
179
180
181
182
183
184
|
# File 'lib/groupdocs/user.rb', line 174
def self.providers!(access = {})
json = Api::Request.new do |request|
request[:access] = access
request[:method] = :GET
request[:path] = '/mgmt/{{client_id}}/storages'
end.execute!
json[:providers].map do |provider|
Storage::Provider.new(provider)
end
end
|
.remove_account!(access = {}) ⇒ String
921
922
923
924
925
926
927
|
# File 'lib/groupdocs/user.rb', line 921
def self.remove_account!(access = {})
Api::Request.new do |request|
request[:access] = access
request[:method] = :DELETE
request[:path] = "/mgmt/{{client_id}}/account"
end.execute!
end
|
.reset_alien_password!(caller_id, access = {}) ⇒ Object
Change alien user password.
830
831
832
833
834
835
836
837
838
|
# File 'lib/groupdocs/user.rb', line 830
def self.reset_alien_password!(caller_id, access = {})
json = Api::Request.new do |request|
request[:access] = access
request[:method] = :DELETE
request[:path] = "/mgmt/#{caller_id}/users/{{client_id}}password"
end.execute!
json[:user_name]
end
|
.reset_token!(caller_id, options = {}, access = {}) ⇒ String
Get user profile by reset token
641
642
643
644
645
646
647
648
649
650
|
# File 'lib/groupdocs/user.rb', line 641
def self.reset_token!(caller_id, options ={}, access = {})
api = Api::Request.new do |request|
request[:access] = access
request[:method] = :GET
request[:path] = "/mgmt/#{caller_id}/reset-tokens"
end
api.add_params(options)
api.execute!
end
|
.revoke!(access = {}) ⇒ Object
232
233
234
235
236
237
238
239
|
# File 'lib/groupdocs/user.rb', line 232
def self.revoke!(access = {})
Api::Request.new do |request|
request[:access] = access
request[:method] = :PUT
request[:path] = "/mgmt/{{client_id}}/revoke"
end.execute!
end
|
.set_user_roles!(caller_id, role_info = {}, access = {}) ⇒ Array
887
888
889
890
891
892
893
894
895
|
# File 'lib/groupdocs/user.rb', line 887
def self.set_user_roles!(caller_id, role_info = {}, access = {})
Api::Request.new do |request|
request[:access] = access
request[:method] = :GET
request[:path] = "/mgmt/#{caller_id}/users/{{client_id}}/roles"
request[:request_body] = role_info
end.execute!
end
|
.update_account!(user, access = {}) ⇒ GroupDocs::User
Updates user account if it’s created, otherwise creates new.
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
# File 'lib/groupdocs/user.rb', line 47
def self.update_account!(user, access = {})
user.is_a?(GroupDocs::User) or raise ArgumentError,
"User should be GroupDocs::User object, received: #{user.inspect}"
data = user.to_hash
json = Api::Request.new do |request|
request[:access] = access
request[:method] = :PUT
request[:path] = "/mgmt/{{client_id}}/account/users/#{user.nickname}"
request[:request_body] = data
end.execute!
GroupDocs::User.new data.merge(json)
end
|
.update_alien_password!(caller_id, pas_info = {}, access = {}) ⇒ Object
Change alien user password.
811
812
813
814
815
816
817
818
819
820
|
# File 'lib/groupdocs/user.rb', line 811
def self.update_alien_password!(caller_id, pas_info = {}, access = {})
json = Api::Request.new do |request|
request[:access] = access
request[:method] = :PUT
request[:path] = "/mgmt/#{caller_id}/users/{{client_id}}password"
request[:request_body] = pas_info
end.execute!
json[:user_guid]
end
|
.update_password!(pas_info = {}, access = {}) ⇒ Object
621
622
623
624
625
626
627
628
|
# File 'lib/groupdocs/user.rb', line 621
def self.update_password!(pas_info = {}, access = {})
Api::Request.new do |request|
request[:access] = access
request[:method] = :PUT
request[:path] = '/mgmt/{{client_id}}/profile/password'
request[:request_body] = pas_info
end.execute!
end
|
.user_roles!(caller_id, access = {}) ⇒ Array
Returns an array of roles.
# @param [String] callerId
867
868
869
870
871
872
873
874
875
|
# File 'lib/groupdocs/user.rb', line 867
def self.user_roles!(caller_id, access = {})
json = Api::Request.new do |request|
request[:access] = access
request[:method] = :GET
request[:path] = "/mgmt/#{caller_id}/users/{{client_id}}/roles"
end.execute!
json[:roles]
end
|
.verif_token!(caller_id, options = {}, access = {}) ⇒ String
Get user profile by reset token
663
664
665
666
667
668
669
670
671
672
|
# File 'lib/groupdocs/user.rb', line 663
def self.verif_token!(caller_id, options ={}, access = {})
api = Api::Request.new do |request|
request[:access] = access
request[:method] = :GET
request[:path] = "/mgmt/#{caller_id}/verif-tokens"
end
api.add_params(options)
api.execute!
end
|
Instance Method Details
#access_rights ⇒ Array<Symbol>
Converts access rights to human-readable format flag.
557
558
559
|
# File 'lib/groupdocs/user.rb', line 557
def access_rights
convert_byte_to_access_rights @access_rights if @access_rights
end
|
#access_rights=(rights) ⇒ Object
Converts access rights to machine-readable format flag.
565
566
567
568
569
570
|
# File 'lib/groupdocs/user.rb', line 565
def access_rights=(rights)
if rights.is_a?(Array)
rights = convert_access_rights_to_byte(rights)
end
@access_rights = rights
end
|
#add_provider!(provider, provider_info = {}, access = {}) ⇒ Object
Adds a new storage provider configuration.
195
196
197
198
199
200
201
202
203
|
# File 'lib/groupdocs/user.rb', line 195
def add_provider!(provider, provider_info = {}, access = {})
Api::Request.new do |request|
request[:access] = access
request[:method] = :POST
request[:path] = "/mgmt/{{client_id}}/storages/#{provider}"
request[:request_body] = provider_info
end.execute!
end
|
#create_user!(caller_id, access = {}) ⇒ GroupDocs::User
764
765
766
767
768
769
770
771
772
|
# File 'lib/groupdocs/user.rb', line 764
def create_user!(caller_id, access = {})
json = Api::Request.new do |request|
request[:access] = access
request[:method] = :POST
request[:path] = "/mgmt/#{caller_id}/user"
request[:request_body] = to_hash
end.execute!
end
|
#get_packages!(path) ⇒ Object
331
332
333
334
335
336
337
338
339
340
341
342
343
|
# File 'lib/groupdocs/user.rb', line 331
def get_packages!(path)
response = Api::Request.new do |request|
request[:sign] = false
request[:method] = :GET
request[:path] = "/shared/packages/#{path}"
end.execute!
Object::File.open(path, 'wb') do |file|
file.write(response)
end
path
end
|
#roles!(access = {}) ⇒ Array
Returns an array of roles.
848
849
850
851
852
853
854
855
856
|
# File 'lib/groupdocs/user.rb', line 848
def roles!(access = {})
json = Api::Request.new do |request|
request[:access] = access
request[:method] = :GET
request[:path] = '/mgmt/{{client_id}}/roles'
end.execute!
json[:roles]
end
|
#update!(access = {}) ⇒ Object
599
600
601
602
603
604
605
606
|
# File 'lib/groupdocs/user.rb', line 599
def update!(access = {})
Api::Request.new do |request|
request[:access] = access
request[:method] = :PUT
request[:path] = '/mgmt/{{client_id}}/profile'
request[:request_body] = to_hash
end.execute!
end
|
#update_profile!(caller_id, access = {}) ⇒ String
Update alien user profile
744
745
746
747
748
749
750
751
752
753
|
# File 'lib/groupdocs/user.rb', line 744
def update_profile!(caller_id, access = {})
json = Api::Request.new do |request|
request[:access] = access
request[:method] = :PUT
request[:path] = "/mgmt/#{caller_id}/user/{{client_id}}/profile"
request[:request_body] = to_hash
end.execute!
json[:user_guid]
end
|
#update_provider!(provider, provider_info = {}, access = {}) ⇒ Object
Updates user’s storage provider configuration.
214
215
216
217
218
219
220
221
222
|
# File 'lib/groupdocs/user.rb', line 214
def update_provider!(provider, provider_info = {}, access = {})
Api::Request.new do |request|
request[:access] = access
request[:method] = :PUT
request[:path] = "/mgmt/{{client_id}}/storages/#{provider}"
request[:request_body] = provider_info
end.execute!
end
|
Get user profile by verif token
682
683
684
685
686
687
688
689
690
691
692
|
# File 'lib/groupdocs/user.rb', line 682
def users!(access = {})
json = Api::Request.new do |request|
request[:access] = access
request[:method] = :GET
request[:path] = '/mgmt/{{client_id}}/account/users'
end.execute!
json[:users].map do |user|
GroupDocs::User.new(user)
end
end
|