Release 4.0.0-preview1-00184
[platform/core/csapi/tizenfx.git] / Artifacts / bin / public / Tizen.Applications.RemoteView.xml
1 <?xml version="1.0"?>
2 <doc>
3     <assembly>
4         <name>Tizen.Applications.RemoteView</name>
5     </assembly>
6     <members>
7         <member name="T:Tizen.Applications.RemoteView">
8             <summary>
9             Represents the proxy class for the widget application.
10             </summary>
11         </member>
12         <member name="T:Tizen.Applications.RemoteView.Event">
13             <summary>
14             The event types to send.
15             </summary>
16         </member>
17         <member name="F:Tizen.Applications.RemoteView.Event.FeedMouseUp">
18             <summary>
19             Type for feeding the mouse-up event to the widget application.
20             </summary>
21         </member>
22         <member name="F:Tizen.Applications.RemoteView.Event.CancelClick">
23             <summary>
24             Type for canceling the click event procedure.
25             </summary>
26         </member>
27         <member name="P:Tizen.Applications.RemoteView.Layout">
28             <summary>
29             Layout object including preview image, overlay text, loading text, and remote screen image.
30             </summary>
31             <privilege>http://tizen.org/privilege/widget.viewer</privilege>
32         </member>
33         <member name="P:Tizen.Applications.RemoteView.Id">
34             <summary>
35             The widget ID.
36             </summary>
37             <privilege>http://tizen.org/privilege/widget.viewer</privilege>
38         </member>
39         <member name="P:Tizen.Applications.RemoteView.Period">
40             <summary>
41             The update period.
42             </summary>
43             <privilege>http://tizen.org/privilege/widget.viewer</privilege>
44         </member>
45         <member name="P:Tizen.Applications.RemoteView.Content">
46             <summary>
47             Contents of the widget.
48             </summary>
49             <remarks>
50             This string can be used for creating contents of the widget again after rebooting a device or it can be recovered from a crash (abnormal status).
51             </remarks>
52             <privilege>http://tizen.org/privilege/widget.viewer</privilege>
53         </member>
54         <member name="P:Tizen.Applications.RemoteView.Title">
55             <summary>
56             Summarized string of the widget content for accessibility.
57             </summary>
58             <privilege>http://tizen.org/privilege/widget.viewer</privilege>
59         </member>
60         <member name="M:Tizen.Applications.RemoteView.PauseAll">
61             <summary>
62             Pauses all the connected widget applications.
63             </summary>
64             <privilege>http://tizen.org/privilege/widget.viewer</privilege>
65             <exception cref="T:System.InvalidOperationException">Thrown when this operation failed.</exception>
66             <exception cref="T:System.UnauthorizedAccessException">Thrown when this operation is denied.</exception>
67             <exception cref="T:System.NotSupportedException">Thrown when this operation is not supported for this device.</exception>
68         </member>
69         <!-- Badly formed XML comment ignored for member "M:Tizen.Applications.RemoteView.ResumeAll" -->
70         <member name="M:Tizen.Applications.RemoteView.Pause">
71             <summary>
72             Pauses the widget application which is connected on this proxy.
73             </summary>
74             <privilege>http://tizen.org/privilege/widget.viewer</privilege>
75             <exception cref="T:System.InvalidOperationException">Thrown when this operation failed.</exception>
76             <exception cref="T:System.UnauthorizedAccessException">Thrown when this operation is denied.</exception>
77             <exception cref="T:System.NotSupportedException">Thrown when this operation is not supported for this device.</exception>
78         </member>
79         <member name="M:Tizen.Applications.RemoteView.Resume">
80             <summary>
81             Resumes the widget application which is connected on this proxy.
82             </summary>
83             <privilege>http://tizen.org/privilege/widget.viewer</privilege>
84             <exception cref="T:System.InvalidOperationException">Thrown when this operation failed.</exception>
85             <exception cref="T:System.UnauthorizedAccessException">Thrown when this operation is denied.</exception>
86             <exception cref="T:System.NotSupportedException">Thrown when this operation is not supported for this device.</exception>
87         </member>
88         <member name="M:Tizen.Applications.RemoteView.SendEvent(Tizen.Applications.RemoteView.Event)">
89             <summary>
90             Sends the event to the widget application which is connected on this proxy.
91             </summary>
92             <privilege>http://tizen.org/privilege/widget.viewer</privilege>
93             <exception cref="T:System.UnauthorizedAccessException">Thrown when this operation is denied.</exception>
94             <exception cref="T:System.NotSupportedException">Thrown when this operation is not supported for this device.</exception>
95         </member>
96         <member name="T:Tizen.Applications.RemoteViewFactory">
97             <summary>
98             Represents a factory class for making the RemoteView objects.
99             </summary>
100         </member>
101         <member name="M:Tizen.Applications.RemoteViewFactory.Init(ElmSharp.EvasObject)">
102             <summary>
103             Initializes RemoteViewFactory.
104             </summary>
105             <param name="win">Window object that will contain RemoteViews that are generated by RemoteViewFactory.
106             All the remote views will be located in the specified window object.
107             </param>
108             <privilege>http://tizen.org/privilege/widget.viewer</privilege>
109             <exception cref="T:System.InvalidOperationException">Thrown when this operation failed.</exception>
110             <exception cref="T:System.UnauthorizedAccessException">Thrown when this operation is denied.</exception>
111             <exception cref="T:System.NotSupportedException">Thrown when this operation is not supported for this device.</exception>
112         </member>
113         <member name="M:Tizen.Applications.RemoteViewFactory.Create(ElmSharp.EvasObject,System.String,System.String,System.Double,System.Boolean,System.Boolean,System.Boolean)">
114             <summary>
115             Creates a RemoteView object.
116             </summary>
117             <param name="parent">Parent object.</param>
118             <param name="widgetId">Widget ID.</param>
119             <param name="content">Contents that will be given to the widget instance.</param>
120             <param name="period">Update period.</param>
121             <param name="previewImage">True if you want to show the preview image.</param>
122             <param name="overlayText">True if you want to show the overlay text.</param>
123             <param name="loadingMessage">True if you want to show the loading message.</param>
124             <returns>RemoteView object.</returns>
125             <privilege>http://tizen.org/privilege/widget.viewer</privilege>
126             <exception cref="T:System.InvalidOperationException">Thrown when this operation failed.</exception>
127             <exception cref="T:System.UnauthorizedAccessException">Thrown when this operation is denied.</exception>
128             <exception cref="T:System.NotSupportedException">Thrown when this operation is not supported for this device.</exception>
129         </member>
130         <member name="M:Tizen.Applications.RemoteViewFactory.Shutdown">
131             <summary>
132             Finalizes the RemoteViewFactory.
133             </summary>
134             <privilege>http://tizen.org/privilege/widget.viewer</privilege>
135             <exception cref="T:System.InvalidOperationException">Thrown when this operation failed.</exception>
136             <exception cref="T:System.UnauthorizedAccessException">Thrown when this operation is denied.</exception>
137             <exception cref="T:System.NotSupportedException">Thrown when this operation is not supported for this device.</exception>
138         </member>
139     </members>
140 </doc>