/
HMCharacteristicWriteAction.xml
308 lines (308 loc) · 18.8 KB
/
HMCharacteristicWriteAction.xml
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
<Type Name="HMCharacteristicWriteAction" FullName="HomeKit.HMCharacteristicWriteAction">
<TypeSignature Language="C#" Value="public class HMCharacteristicWriteAction : HomeKit.HMAction" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit HMCharacteristicWriteAction extends HomeKit.HMAction" />
<TypeSignature Language="DocId" Value="T:HomeKit.HMCharacteristicWriteAction" />
<TypeSignature Language="F#" Value="type HMCharacteristicWriteAction = class
 inherit HMAction" />
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>HomeKit.HMAction</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>Foundation.Register("HMCharacteristicWriteAction", true)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Introduced(ObjCRuntime.PlatformName.TvOS, 10, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 8, 0, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>An <see cref="T:HomeKit.HMAction" /> that sets a value in a <see cref="T:HomeKit.HMCharacteristic" />.</summary>
<remarks>To be added.</remarks>
<related type="externalDocumentation" href="https://developer.apple.com/library/ios/documentation/HomeKit/Reference/HMCharacteristicWriteAction_Class/index.html">Apple documentation for <c>HMCharacteristicWriteAction</c></related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected HMCharacteristicWriteAction (Foundation.NSObjectFlag t);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class Foundation.NSObjectFlag t) cil managed" />
<MemberSignature Language="DocId" Value="M:HomeKit.HMCharacteristicWriteAction.#ctor(Foundation.NSObjectFlag)" />
<MemberSignature Language="F#" Value="new HomeKit.HMCharacteristicWriteAction : Foundation.NSObjectFlag -> HomeKit.HMCharacteristicWriteAction" Usage="new HomeKit.HMCharacteristicWriteAction t" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="t" Type="Foundation.NSObjectFlag" />
</Parameters>
<Docs>
<param name="t">Unused sentinel value, pass NSObjectFlag.Empty.</param>
<summary>Constructor to call on derived classes to skip initialization and merely allocate the object.</summary>
<remarks>
<para>This constructor should be called by derived classes when they completely construct the object in managed code and merely want the runtime to allocate and initialize the NSObject. This is required to implement the two-step initialization process that Objective-C uses, the first step is to perform the object allocation, the second step is to initialize the object. When developers invoke the constructor that takes the NSObjectFlag.Empty they take advantage of a direct path that goes all the way up to NSObject to merely allocate the object's memory and bind the Objective-C and C# objects together. The actual initialization of the object is up to the developer.</para>
<para>This constructor is typically used by the binding generator to allocate the object, but prevent the actual initialization to take place. Once the allocation has taken place, the constructor has to initialize the object. With constructors generated by the binding generator this means that it manually invokes one of the "init" methods to initialize the object.</para>
<para>It is the developer's responsibility to completely initialize the object if they chain up using the NSObjectFlag.Empty path.</para>
<para>In general, if the developer's constructor invokes the NSObjectFlag.Empty base implementation, then it should be calling an Objective-C init method. If this is not the case, developers should instead chain to the proper constructor in their class. </para>
<para>The argument value is ignored and merely ensures that the only code that is executed is the construction phase is the basic NSObject allocation and runtime type registration. Typically the chaining would look like this:</para>
<example>
<code lang="csharp lang-csharp"><![CDATA[
//
// The NSObjectFlag merely allocates the object and registers the
// C# class with the Objective-C runtime if necessary, but no actual
// initXxx method is invoked, that is done later in the constructor
//
// This is taken from Xamarin.iOS's source code:
//
[Export ("initWithFrame:")]
public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
{
// Invoke the init method now.
var initWithFrame = new Selector ("initWithFrame:").Handle;
if (IsDirectBinding)
Handle = ObjCRuntime.Messaging.IntPtr_objc_msgSend_CGRect (this.Handle, initWithFrame, frame);
else
Handle = ObjCRuntime.Messaging.IntPtr_objc_msgSendSuper_CGRect (this.SuperHandle, initWithFrame, frame);
}
]]></code>
</example>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected internal HMCharacteristicWriteAction (IntPtr handle);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
<MemberSignature Language="DocId" Value="M:HomeKit.HMCharacteristicWriteAction.#ctor(System.IntPtr)" />
<MemberSignature Language="F#" Value="new HomeKit.HMCharacteristicWriteAction : nativeint -> HomeKit.HMCharacteristicWriteAction" Usage="new HomeKit.HMCharacteristicWriteAction handle" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="handle" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="handle">Pointer (handle) to the unmanaged object.</param>
<summary>A constructor used when creating managed representations of unmanaged objects; Called by the runtime.</summary>
<remarks>
<para>This constructor is invoked by the runtime infrastructure (<see cref="M:ObjCRuntime.Runtime.GetNSObject(System.IntPtr)" />) to create a new managed representation for a pointer to an unmanaged Objective-C object. Developers should not invoke this method directly, instead they should call the GetNSObject method as it will prevent two instances of a managed object to point to the same native object.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HMCharacteristicWriteAction (HomeKit.HMCharacteristic characteristic, Foundation.NSObject targetValue);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class HomeKit.HMCharacteristic characteristic, class Foundation.NSObject targetValue) cil managed" />
<MemberSignature Language="DocId" Value="M:HomeKit.HMCharacteristicWriteAction.#ctor(HomeKit.HMCharacteristic,Foundation.NSObject)" />
<MemberSignature Language="F#" Value="new HomeKit.HMCharacteristicWriteAction : HomeKit.HMCharacteristic * Foundation.NSObject -> HomeKit.HMCharacteristicWriteAction" Usage="new HomeKit.HMCharacteristicWriteAction (characteristic, targetValue)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Foundation.Export("initWithCharacteristic:targetValue:")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.DesignatedInitializer</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.TvOS, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.WatchOS, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="characteristic" Type="HomeKit.HMCharacteristic" />
<Parameter Name="targetValue" Type="Foundation.NSObject" />
</Parameters>
<Docs>
<param name="characteristic">To be added.</param>
<param name="targetValue">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Characteristic">
<MemberSignature Language="C#" Value="public virtual HomeKit.HMCharacteristic Characteristic { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class HomeKit.HMCharacteristic Characteristic" />
<MemberSignature Language="DocId" Value="P:HomeKit.HMCharacteristicWriteAction.Characteristic" />
<MemberSignature Language="F#" Value="member this.Characteristic : HomeKit.HMCharacteristic" Usage="HomeKit.HMCharacteristicWriteAction.Characteristic" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: Foundation.Export("characteristic", ObjCRuntime.ArgumentSemantic.Strong)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>HomeKit.HMCharacteristic</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the characteristic that will be written in the action.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClassHandle">
<MemberSignature Language="C#" Value="public override IntPtr ClassHandle { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance native int ClassHandle" />
<MemberSignature Language="DocId" Value="P:HomeKit.HMCharacteristicWriteAction.ClassHandle" />
<MemberSignature Language="F#" Value="member this.ClassHandle : nativeint" Usage="HomeKit.HMCharacteristicWriteAction.ClassHandle" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>The handle for this class.</summary>
<value>The pointer to the Objective-C class.</value>
<remarks>Each Xamarin.iOS class mirrors an unmanaged Objective-C class. This value contains the pointer to the Objective-C class, it is similar to calling objc_getClass with the object name.</remarks>
</Docs>
</Member>
<Member MemberName="TargetValue">
<MemberSignature Language="C#" Value="public virtual Foundation.NSObject TargetValue { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Foundation.NSObject TargetValue" />
<MemberSignature Language="DocId" Value="P:HomeKit.HMCharacteristicWriteAction.TargetValue" />
<MemberSignature Language="F#" Value="member this.TargetValue : Foundation.NSObject" Usage="HomeKit.HMCharacteristicWriteAction.TargetValue" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: Foundation.Export("targetValue", ObjCRuntime.ArgumentSemantic.Copy)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Foundation.NSObject</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the value that will be written to the characteristic by the action.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UpdateTargetValue">
<MemberSignature Language="C#" Value="public virtual void UpdateTargetValue (Foundation.NSObject targetValue, Action<Foundation.NSError> completion);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void UpdateTargetValue(class Foundation.NSObject targetValue, class System.Action`1<class Foundation.NSError> completion) cil managed" />
<MemberSignature Language="DocId" Value="M:HomeKit.HMCharacteristicWriteAction.UpdateTargetValue(Foundation.NSObject,System.Action{Foundation.NSError})" />
<MemberSignature Language="F#" Value="abstract member UpdateTargetValue : Foundation.NSObject * Action<Foundation.NSError> -> unit
override this.UpdateTargetValue : Foundation.NSObject * Action<Foundation.NSError> -> unit" Usage="hMCharacteristicWriteAction.UpdateTargetValue (targetValue, completion)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Foundation.Export("updateTargetValue:completionHandler:")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.TvOS, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.WatchOS, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="targetValue" Type="Foundation.NSObject" />
<Parameter Name="completion" Type="System.Action<Foundation.NSError>">
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BlockProxy(typeof(ObjCRuntime.Trampolines/NIDActionArity1V9))</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="targetValue">To be added.</param>
<param name="completion">A handler that returns <see langword="null" /> on success, or an error object on failure.</param>
<summary>Updates <paramref name="targetValue" /> and runs <paramref name="completion" /> after it has finished.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UpdateTargetValueAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task UpdateTargetValueAsync (Foundation.NSObject targetValue);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task UpdateTargetValueAsync(class Foundation.NSObject targetValue) cil managed" />
<MemberSignature Language="DocId" Value="M:HomeKit.HMCharacteristicWriteAction.UpdateTargetValueAsync(Foundation.NSObject)" />
<MemberSignature Language="F#" Value="abstract member UpdateTargetValueAsync : Foundation.NSObject -> System.Threading.Tasks.Task
override this.UpdateTargetValueAsync : Foundation.NSObject -> System.Threading.Tasks.Task" Usage="hMCharacteristicWriteAction.UpdateTargetValueAsync targetValue" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.TvOS, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.WatchOS, ObjCRuntime.PlatformArchitecture.All, null)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="targetValue" Type="Foundation.NSObject" />
</Parameters>
<Docs>
<param name="targetValue">To be added.</param>
<summary>Updates <paramref name="targetValue" /> and runs <paramref name="completion" /> after it has finished.</summary>
<returns>A task that represents the asynchronous UpdateTargetValue operation</returns>
<remarks>
<para copied="true">The UpdateTargetValueAsync method is suitable to be used with C# async by returning control to the caller with a Task representing the operation.</para>
<para copied="true">To be added.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>