Release 4.0.0-preview1-00201
[platform/core/csapi/tizenfx.git] / Artifacts / bin / public / Tizen.Applications.AttachPanel.xml
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Tizen.Applications.AttachPanel</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="T:Tizen.Applications.AttachPanel.AttachPanel">\r
8             <summary>\r
9             Represents immutable class for attach panel.\r
10             </summary>\r
11         </member>\r
12         <member name="M:Tizen.Applications.AttachPanel.AttachPanel.#ctor(System.IntPtr)">\r
13             <summary>\r
14             Represents immutable class for attach panel.\r
15             </summary>\r
16             <since_tizen> 3 </since_tizen>\r
17             <param name="conformant">The caller's conformant</param>\r
18             <exception cref="T:System.OutOfMemoryException">Thrown when an attempt to allocate memory fails.</exception>\r
19             <exception cref="T:System.InvalidOperationException">Thrown when the AttachPanel is already exist or the <paramref name="conformant"/> is not a conformant object</exception>\r
20         </member>\r
21         <member name="P:Tizen.Applications.AttachPanel.AttachPanel.State">\r
22             <summary>\r
23             Gets the state of the AttachPanel.\r
24             </summary>\r
25             <value>The AttachPanel window state</value>\r
26         </member>\r
27         <member name="P:Tizen.Applications.AttachPanel.AttachPanel.Visible">\r
28             <summary>\r
29             Gets the value that indicates whether the AttachPanel is visible.\r
30             </summary>\r
31             <value>visible value of AttachPanel state</value>\r
32         </member>\r
33         <member name="M:Tizen.Applications.AttachPanel.AttachPanel.AddCategory(Tizen.Applications.AttachPanel.ContentCategory,Tizen.Applications.Bundle)">\r
34             <summary>\r
35             Add a content category in the AttachPanel.\r
36             </summary>\r
37             <param name="category">The ContentCategory to be added in the AttachPanel</param>\r
38             <param name="extraData">The AttachPanel send some information using Bundle</param>\r
39             <privilege>http://tizen.org/privilege/mediastorage</privilege>\r
40             <privilege>http://tizen.org/privilege/camera</privilege>\r
41             <privilege>http://tizen.org/privilege/recorder</privilege>\r
42             <privilege>http://tizen.org/privilege/appmanager.launch</privilege>\r
43             <feature>http://tizen.org/feature/camera</feature>\r
44             <feature>http://tizen.org/feature/microphone</feature>\r
45             <remarks>\r
46             The caller app has to check the return value of this function.\r
47             Content categories will be shown as the sequence of using AddCategory\r
48             Some contents need time to load it all.\r
49             So, it is needed to use this before the mainloop of Show\r
50             Privileges,\r
51             http://tizen.org/privilege/mediastorage, for using Image or Camera\r
52             http://tizen.org/privilege/camera, for using Camera or TakePicture\r
53             http://tizen.org/privilege/recorder, for using Voice\r
54             http://tizen.org/privilege/appmanager.launch, for adding content categories on the More tab\r
55             http://tizen.org/feature/camera, for using Camera or TakePicture\r
56             http://tizen.org/feature/microphone, for using Voice\r
57             Deliver more information to the callee with a bundle if you need.\r
58             http://tizen.org/appcontrol/data/total_count\r
59             http://tizen.org/appcontrol/data/total_size\r
60             </remarks>\r
61             <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="category"/> is not a valid category</exception>\r
62             <exception cref="T:System.UnauthorizedAccessException">Thrown when application does not have privilege to access this method</exception>\r
63             <exception cref="T:System.NotSupportedException">Thrown when the device does not supported the <paramref name="category"/> feature </exception>\r
64             <exception cref="T:System.InvalidOperationException">Thrown when the AttachPanel is not created yet or already destroyed</exception>\r
65         </member>\r
66         <member name="M:Tizen.Applications.AttachPanel.AttachPanel.RemoveCategory(Tizen.Applications.AttachPanel.ContentCategory)">\r
67             <summary>\r
68             Removes the ContentCategory from the AttachPanel\r
69             </summary>\r
70             <param name="category">The ContentCategory adding in the AttachPanel</param>\r
71              <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="category"/> is not a valid category</exception>\r
72             <exception cref="T:System.InvalidOperationException">Thrown when the AttachPanel is not created yet or already destroyed</exception>\r
73         </member>\r
74         <member name="M:Tizen.Applications.AttachPanel.AttachPanel.SetExtraData(Tizen.Applications.AttachPanel.ContentCategory,Tizen.Applications.Bundle)">\r
75             <summary>\r
76             Sets extraData to send to the ContentCategory using a Bundle\r
77             </summary>\r
78             <param name="category">The ContentCategory that some information to be set in the AttachPanel.</param>\r
79             <param name="extraData">The AttachPanel send some information using Bundle</param>\r
80             <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="category"/> is not a valid category</exception>\r
81             <exception cref="T:System.InvalidOperationException">Thrown when the AttachPanel is destroyed</exception>\r
82             <exception cref="T:System.OutOfMemoryException">Thrown when an attempt to allocate memory fails.</exception>\r
83         </member>\r
84         <member name="M:Tizen.Applications.AttachPanel.AttachPanel.Show">\r
85             <summary>\r
86             Shows the attach panel with animations\r
87             </summary>\r
88             <exception cref="T:System.InvalidOperationException">Thrown when the AttachPanel is destroyed</exception>\r
89         </member>\r
90         <member name="M:Tizen.Applications.AttachPanel.AttachPanel.Show(System.Boolean)">\r
91             <summary>\r
92             Shows the attach panel and selects whether or not to animate\r
93             </summary>\r
94             <exception cref="T:System.InvalidOperationException">Thrown when the AttachPanel is destroyed</exception>\r
95         </member>\r
96         <member name="M:Tizen.Applications.AttachPanel.AttachPanel.Hide">\r
97             <summary>\r
98             Hides the attach panel with animations\r
99             </summary>\r
100             <exception cref="T:System.InvalidOperationException">Thrown when the AttachPanel is destroyed</exception>\r
101         </member>\r
102         <member name="M:Tizen.Applications.AttachPanel.AttachPanel.Hide(System.Boolean)">\r
103             <summary>\r
104             Hides the attach panel and selects whether or not to animate\r
105             </summary>\r
106             <exception cref="T:System.InvalidOperationException">Thrown when the AttachPanel is destroyed</exception>\r
107         </member>\r
108         <member name="E:Tizen.Applications.AttachPanel.AttachPanel.EventChanged">\r
109             <summary>\r
110             Occurs when reserved events are published from the panel-side.\r
111             </summary>\r
112         </member>\r
113         <member name="E:Tizen.Applications.AttachPanel.AttachPanel.ResultCallback">\r
114             <summary>\r
115             Occurs when an user selects and confirms something to attach in the AttachPanel\r
116             </summary>\r
117         </member>\r
118         <member name="T:Tizen.Applications.AttachPanel.ContentCategory">\r
119             <summary>\r
120             Enumeration for the attach panel content category.\r
121             </summary>\r
122         </member>\r
123         <member name="F:Tizen.Applications.AttachPanel.ContentCategory.Image">\r
124             <summary>\r
125             Attaching images from the gallery\r
126             </summary>\r
127         </member>\r
128         <member name="F:Tizen.Applications.AttachPanel.ContentCategory.Camera">\r
129             <summary>\r
130             Taking pictures to attach\r
131             </summary>\r
132         </member>\r
133         <member name="F:Tizen.Applications.AttachPanel.ContentCategory.Voice">\r
134             <summary>\r
135             Taking a voice clip to attach\r
136             </summary>\r
137         </member>\r
138         <member name="F:Tizen.Applications.AttachPanel.ContentCategory.Video">\r
139             <summary>\r
140             Attaching video from the gallery\r
141             </summary>\r
142         </member>\r
143         <member name="F:Tizen.Applications.AttachPanel.ContentCategory.Audio">\r
144             <summary>\r
145             Attaching audio from my files\r
146             </summary>\r
147         </member>\r
148         <member name="F:Tizen.Applications.AttachPanel.ContentCategory.Calendar">\r
149             <summary>\r
150             Attaching calendar data from the calendar\r
151             </summary>\r
152         </member>\r
153         <member name="F:Tizen.Applications.AttachPanel.ContentCategory.Contact">\r
154             <summary>\r
155             Attaching contact data from the contacts\r
156             </summary>\r
157         </member>\r
158         <member name="F:Tizen.Applications.AttachPanel.ContentCategory.Myfiles">\r
159             <summary>\r
160             Attaching files data from my files\r
161             </summary>\r
162         </member>\r
163         <member name="F:Tizen.Applications.AttachPanel.ContentCategory.VideoRecorder">\r
164             <summary>\r
165             Taking a video clip to attach\r
166             </summary>\r
167         </member>\r
168         <member name="F:Tizen.Applications.AttachPanel.ContentCategory.Document">\r
169             <summary>\r
170             Attaching files from the document list\r
171             </summary>\r
172         </member>\r
173         <member name="F:Tizen.Applications.AttachPanel.ContentCategory.TakePicture">\r
174             <summary>\r
175             Launching apps to take pictures will be attached\r
176             </summary>\r
177         </member>\r
178         <member name="F:Tizen.Applications.AttachPanel.ContentCategory.Memo">\r
179             <summary>\r
180             Attaching memo data from the memo\r
181             </summary>\r
182         </member>\r
183         <member name="T:Tizen.Applications.AttachPanel.EventType">\r
184             <summary>\r
185             Enumeration for the attach panel event.\r
186             </summary>\r
187         </member>\r
188         <member name="F:Tizen.Applications.AttachPanel.EventType.ShowStart">\r
189             <summary>\r
190             Attach panel starts the effect to show\r
191             </summary>\r
192         </member>\r
193         <member name="F:Tizen.Applications.AttachPanel.EventType.ShowFinish">\r
194             <summary>\r
195             Attach panel finishes the effect to show\r
196             </summary>\r
197         </member>\r
198         <member name="F:Tizen.Applications.AttachPanel.EventType.HideStart">\r
199             <summary>\r
200             Attach panel starts the effect to hide the panel\r
201             </summary>\r
202         </member>\r
203         <member name="F:Tizen.Applications.AttachPanel.EventType.HideFinish">\r
204             <summary>\r
205             Attach panel finishes the effect to hide the panel\r
206             </summary>\r
207         </member>\r
208         <member name="T:Tizen.Applications.AttachPanel.ResultEventArgs">\r
209             <summary>\r
210             Class for event arguments of the result event\r
211             </summary>\r
212         </member>\r
213         <member name="P:Tizen.Applications.AttachPanel.ResultEventArgs.AttachPanel">\r
214             <summary>\r
215              Property for attach panel object.\r
216             </summary>\r
217         </member>\r
218         <member name="P:Tizen.Applications.AttachPanel.ResultEventArgs.Category">\r
219             <summary>\r
220             Results are from the content category.\r
221             </summary>\r
222         </member>\r
223         <member name="P:Tizen.Applications.AttachPanel.ResultEventArgs.Result">\r
224             <summary>\r
225             Property for result\r
226             The caller app has to use ExtraData property to get received data.\r
227             </summary>\r
228         </member>\r
229         <member name="P:Tizen.Applications.AttachPanel.ResultEventArgs.ResultCode">\r
230             <summary>\r
231             Property for result of AppControl\r
232             </summary>\r
233         </member>\r
234         <member name="P:Tizen.Applications.AttachPanel.ResultEventArgs.UserData">\r
235             <summary>\r
236             Property for user data\r
237             </summary>\r
238         </member>\r
239         <member name="T:Tizen.Applications.AttachPanel.StateEventArgs">\r
240             <summary>\r
241             Class for event arguments of the state event\r
242             </summary>\r
243         </member>\r
244         <member name="P:Tizen.Applications.AttachPanel.StateEventArgs.AttachPanel">\r
245             <summary>\r
246             Property for attach panel object\r
247             </summary>\r
248         </member>\r
249         <member name="P:Tizen.Applications.AttachPanel.StateEventArgs.EventType">\r
250             <summary>\r
251             Property for event type.\r
252             </summary>\r
253         </member>\r
254         <member name="P:Tizen.Applications.AttachPanel.StateEventArgs.EventInfo">\r
255             <summary>\r
256             Additional event information.\r
257             This can be NULL if there are no necessary information.\r
258             </summary>\r
259         </member>\r
260         <member name="P:Tizen.Applications.AttachPanel.StateEventArgs.UserData">\r
261             <summary>\r
262             Property for user data.\r
263             </summary>\r
264         </member>\r
265         <member name="T:Tizen.Applications.AttachPanel.StateType">\r
266             <summary>\r
267             Enumeration for the attach panel's window state.\r
268             </summary>\r
269         </member>\r
270         <member name="F:Tizen.Applications.AttachPanel.StateType.Hidden">\r
271             <summary>\r
272             Attach panel is not visible\r
273             </summary>\r
274         </member>\r
275         <member name="F:Tizen.Applications.AttachPanel.StateType.Partial">\r
276             <summary>\r
277             Attach panel is in partial window mode\r
278             </summary>\r
279         </member>\r
280         <member name="F:Tizen.Applications.AttachPanel.StateType.Full">\r
281             <summary>\r
282             Attach panel is in full screen mode\r
283             </summary>\r
284         </member>\r
285     </members>\r
286 </doc>\r