UNPKG

box-chrome-sdk

Version:

A Chrome App SDK for the Box V2 API

github.com/box/Chrome-App-SDK

box/Chrome-App-SDK

126 lines (62 loc) • 2.24 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
**Overview:** Box User object. @see http://developers.box.com/docs/#users **Author:** jmeadows BoxUser.assignTaskTo(task) -------------------------- Assigns a task to the user. **Parameters** **task**: *Task* | *Object*, The task to assign to the user. **Returns** *Observable*, An observable containing the Box API response for this request. BoxUser.update(params, notify) ------------------------------ Update the enterprise user's information if the current user is an enterprise admin. **Parameters** **params**: *Object*, A hash containing key/value pairs of the user fields to update **notify**: *Boolean*, Whether to notify the affected user when they are rolled out of the enterprise. **Returns** *Observable*, An observable containing a new User object with the updated parameters. BoxUser.delete(notify, force) ----------------------------- Delete the enterprise user if the current user is an enterprise admin. **Parameters** **notify**: *Boolean*, Whether to notify the affected user. **force**: *Boolean*, Whether or not to delete the user even if they still own files **Returns** *Observable*, An empty observable. BoxUser.getEmailAliases() ------------------------- Get a user's email address aliases. Doesn't include the primary login, which is included in the User object. **Returns** *Observable*, An observable sequence of email alias objects. BoxUser.addEmailAlias(email) ---------------------------- Add a new email alias to the user's account. **Parameters** **email**: *String*, The email address to add to the user's account **Returns** *Observable*, An observable containing the newly created email alias object. BoxUser.deleteEmailAlias(emailAlias) ------------------------------------ Delete the email alias from the user's account. **Parameters** **emailAlias**: *Object*, The email alias object to remove from the user's account. **Returns** *Observable*, An empty observable. class BoxUser.User ------------------ **Members** **boxHttp**, **urlType**, **task**, **id**, **type**, **assign_to**, **id**, **login**, **notify**, **notify**, **force**, **owned_by**, **id**, **email**, **constructor**,