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