UNPKG

box-chrome-sdk

Version:

A Chrome App SDK for the Box V2 API

github.com/box/Chrome-App-SDK

box/Chrome-App-SDK

150 lines (74 loc) • 2.61 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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
**Overview:** Box Metadata object. **Author:** jmeadows BoxMetadata.sendUpdate(update) ------------------------------ Updates this metadata object with the instructions specified in the given update object. **Parameters** **update**: *MetadataUpdate*, A metadata update object specifying what to update. **Returns** *Observable*, An observable containing the updated metadata object BoxMetadata.delete() -------------------- Delete this metadata object. **Returns** *Observable*, An observable containing the Box API response for this request. BoxMetadata.startUpdate() ------------------------- Create a metadata update object that can be used to update this metadata object. **Returns** *MetadataUpdate*, The update object that can be used to update this metadata object. BoxMetadata.add(path, value) ---------------------------- Adds an instruction to this update object to add a new key/value pair to the metadata object. **Parameters** **path**: *String*, Specifies where to add the key **value**: *String*, The value to add **Returns** *undefined*, void BoxMetadata.remove(path, oldValue) ---------------------------------- Adds an instruction to this update object to remove a key/value pair from the metadata object. **Parameters** **path**: *String*, Specifies which key to remove **oldValue**: *String*, If specified, will only execute the replace if the current value matches this parameter **Returns** *undefined*, void BoxMetadata.replace(path, value, oldValue) ------------------------------------------ Adds an instruction to this update object to replace **Parameters** **path**: *String*, Specifies which key to replace **value**: *String*, The new value for the specified key **oldValue**: *String*, If specified, will only execute the replace if the current value matches this parameter **Returns** *undefined*, void BoxMetadata.test(path, value) ----------------------------- Adds an instruction to this update object to test the metadata object for the existence of a key/value pair. The next instruction will only be executed if this test passes. **Parameters** **path**: *String*, Sepcifies which key to test **value**: *String*, Specifies the value to test for **Returns** *undefined*, void class BoxMetadata.Metadata -------------------------- **Members** **file**, **boxHttp**, **ops**, **file**, **headers**, **Content-Type**, **op**, **path**, **value**, **op**, **path**, **op**, **path**, **value**, **op**, **path**, **value**, **constructor**,