~ubuntu-branches/ubuntu/trusty/monodevelop/trusty-proposed

« back to all changes in this revision

Viewing changes to external/monomac/docs/en/MonoMac.Foundation/NSUrlConnection.xml

  • Committer: Package Import Robot
  • Author(s): Jo Shields
  • Date: 2013-05-12 09:46:03 UTC
  • mto: This revision was merged to the branch mainline in revision 29.
  • Revision ID: package-import@ubuntu.com-20130512094603-mad323bzcxvmcam0
Tags: upstream-4.0.5+dfsg
ImportĀ upstreamĀ versionĀ 4.0.5+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
17
17
  <Docs>
18
18
    <summary>A Web Client.</summary>
19
19
    <remarks>To be added.</remarks>
 
20
    <related type="sample" href="http://samples.xamarin.com/Samples/ByGuid?guid=d01773c4-0073-4ca2-852f-2c2781f12484">HttpClient</related>
20
21
  </Docs>
21
22
  <Members>
22
23
    <Member MemberName=".ctor">
30
31
        <Attribute>
31
32
          <AttributeName>MonoMac.Foundation.Export("init")</AttributeName>
32
33
        </Attribute>
 
34
        <Attribute>
 
35
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
36
        </Attribute>
33
37
      </Attributes>
34
38
      <Parameters />
35
39
      <Docs>
49
53
        <Attribute>
50
54
          <AttributeName>MonoMac.Foundation.Export("initWithCoder:")</AttributeName>
51
55
        </Attribute>
 
56
        <Attribute>
 
57
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
58
        </Attribute>
52
59
      </Attributes>
53
60
      <Parameters>
54
61
        <Parameter Name="coder" Type="MonoMac.Foundation.NSCoder" />
66
73
      <AssemblyInfo>
67
74
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
68
75
      </AssemblyInfo>
 
76
      <Attributes>
 
77
        <Attribute>
 
78
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
79
        </Attribute>
 
80
      </Attributes>
69
81
      <Parameters>
70
82
        <Parameter Name="t" Type="MonoMac.Foundation.NSObjectFlag" />
71
83
      </Parameters>
72
84
      <Docs>
73
85
        <param name="t">Unused sentinel value, pass NSObjectFlag.Empty.</param>
74
 
        <summary>Constructor to call on derived classes to skip initialization and merely allocate the object.</summary>
 
86
        <summary>Constructor to call on derived classes when the derived class has an [Export] constructor.</summary>
75
87
        <remarks>
76
 
          <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 you invoke the constructor that takes the NSObjectFlag.Empty you taking advatnage 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 you.</para>
77
 
          <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>
78
 
          <para>It is your responsability to completely initialize the object if you chain up using the NSObjectFlag.Empty path.</para>
79
 
          <para>In general, if your constructors invokes the NSObjectFlag.Empty base implementation, then it should be calling an Objective-C init method.   If this is not the case, you should instead chain to the proper constructor in your class. </para>
80
 
          <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>
 
88
          <para>This constructor should be called by derived classes when they are initialized using an [Export] attribute. The argument value is ignore, typically the chaining would look like this:</para>
81
89
          <example>
82
90
            <code lang="C#">
83
 
//
84
 
// The NSObjectFlag merely allocates the object and registers the
85
 
// C# class with the Objective-C runtime if necessary, but no actual
86
 
// initXxx method is invoked, that is done later in the constructor
87
 
//
88
 
// This is taken from MonoMac's source code:
89
 
//
90
 
[Export ("initWithFrame:")]
91
 
public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
92
 
{
93
 
// Invoke the init method now.
94
 
        var initWithFrame = new Selector ("initWithFrame:").Handle;
95
 
        if (IsDirectBinding)
96
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSend_RectangleF (this.Handle, initWithFrame, frame);
97
 
        else
98
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSendSuper_RectangleF (this.SuperHandle, initWithFrame, frame);
99
 
}
 
91
public class MyClass : BaseClass {
 
92
    [Export ("initWithFoo:")]
 
93
    public MyClass (string foo) : base (NSObjectFlag.Empty)
 
94
    {
 
95
        ...
 
96
    }
100
97
</code>
101
98
          </example>
102
99
        </remarks>
109
106
      <AssemblyInfo>
110
107
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
111
108
      </AssemblyInfo>
 
109
      <Attributes>
 
110
        <Attribute>
 
111
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
112
        </Attribute>
 
113
      </Attributes>
112
114
      <Parameters>
113
115
        <Parameter Name="handle" Type="System.IntPtr" />
114
116
      </Parameters>
287
289
      </AssemblyInfo>
288
290
      <Attributes>
289
291
        <Attribute>
 
292
          <AttributeName>MonoMac.ObjCRuntime.Since(5, 0)</AttributeName>
 
293
        </Attribute>
 
294
        <Attribute>
290
295
          <AttributeName>get: MonoMac.Foundation.Export("currentRequest")</AttributeName>
291
296
        </Attribute>
292
297
      </Attributes>
316
321
        <param name="disposing">
317
322
          <para>If set to <see langword="true" />, the method is invoked directly and will dispose manage and unmanaged resources;   If set to <see langword="false" /> the method is being called by the garbage collector finalizer and should only release unmanaged resources.</para>
318
323
        </param>
319
 
        <summary>Releases the resourced used by the NSUrlConnection object.</summary>
 
324
        <summary>Releases the resources used by the NSUrlConnection object.</summary>
320
325
        <remarks>
321
326
          <para>This Dispose method releases the resources used by the NSUrlConnection class.</para>
322
327
          <para>This method is called by both the Dispose() method and the object finalizer (Finalize).    When invoked by the Dispose method, the parameter disposting <paramref name="disposing" /> is set to <see langword="true" /> and any managed object references that this object holds are also disposed or released;  when invoked by the object finalizer, on the finalizer thread the value is set to <see langword="false" />. </para>
361
366
      </AssemblyInfo>
362
367
      <Attributes>
363
368
        <Attribute>
 
369
          <AttributeName>MonoMac.ObjCRuntime.Since(5, 0)</AttributeName>
 
370
        </Attribute>
 
371
        <Attribute>
364
372
          <AttributeName>get: MonoMac.Foundation.Export("originalRequest")</AttributeName>
365
373
        </Attribute>
366
374
      </Attributes>
374
382
      </Docs>
375
383
    </Member>
376
384
    <Member MemberName="Schedule">
 
385
      <MemberSignature Language="C#" Value="public virtual void Schedule (MonoMac.Foundation.NSRunLoop aRunLoop, MonoMac.Foundation.NSString forMode);" />
 
386
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Schedule(class MonoMac.Foundation.NSRunLoop aRunLoop, class MonoMac.Foundation.NSString forMode) cil managed" />
 
387
      <MemberType>Method</MemberType>
 
388
      <AssemblyInfo>
 
389
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
390
      </AssemblyInfo>
 
391
      <Attributes>
 
392
        <Attribute>
 
393
          <AttributeName>MonoMac.Foundation.Export("scheduleInRunLoop:forMode:")</AttributeName>
 
394
        </Attribute>
 
395
      </Attributes>
 
396
      <ReturnValue>
 
397
        <ReturnType>System.Void</ReturnType>
 
398
      </ReturnValue>
 
399
      <Parameters>
 
400
        <Parameter Name="aRunLoop" Type="MonoMac.Foundation.NSRunLoop" />
 
401
        <Parameter Name="forMode" Type="MonoMac.Foundation.NSString" />
 
402
      </Parameters>
 
403
      <Docs>
 
404
        <param name="aRunLoop">The run loop to use.</param>
 
405
        <param name="forMode">The mode to use.</param>
 
406
        <summary>Sets the run loop and mode this connection uses.</summary>
 
407
        <remarks>.</remarks>
 
408
      </Docs>
 
409
    </Member>
 
410
    <Member MemberName="Schedule">
377
411
      <MemberSignature Language="C#" Value="public virtual void Schedule (MonoMac.Foundation.NSRunLoop aRunLoop, string forMode);" />
378
412
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Schedule(class MonoMac.Foundation.NSRunLoop aRunLoop, string forMode) cil managed" />
379
413
      <MemberType>Method</MemberType>
384
418
        <Attribute>
385
419
          <AttributeName>MonoMac.Foundation.Export("scheduleInRunLoop:forMode:")</AttributeName>
386
420
        </Attribute>
 
421
        <Attribute>
 
422
          <AttributeName>System.Obsolete("Use Schedule (NSRunLoop, NSString) instead")</AttributeName>
 
423
        </Attribute>
387
424
      </Attributes>
388
425
      <ReturnValue>
389
426
        <ReturnType>System.Void</ReturnType>
393
430
        <Parameter Name="forMode" Type="System.String" />
394
431
      </Parameters>
395
432
      <Docs>
396
 
        <param name="aRunLoop">To be added.</param>
397
 
        <param name="forMode">To be added.</param>
398
 
        <summary>To be added.</summary>
399
 
        <remarks>To be added.</remarks>
 
433
        <param name="aRunLoop">The run loop to use.</param>
 
434
        <param name="forMode">The mode to use.</param>
 
435
        <summary>Sets the run loop and mode this connection uses.</summary>
 
436
        <remarks>This method is obsolete. Use the Schedule (NSRunLoop, NSString) overload instead.</remarks>
400
437
      </Docs>
401
438
    </Member>
402
439
    <Member MemberName="SendAsynchronousRequest">
497
534
      </Docs>
498
535
    </Member>
499
536
    <Member MemberName="Unschedule">
 
537
      <MemberSignature Language="C#" Value="public virtual void Unschedule (MonoMac.Foundation.NSRunLoop aRunLoop, MonoMac.Foundation.NSString forMode);" />
 
538
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Unschedule(class MonoMac.Foundation.NSRunLoop aRunLoop, class MonoMac.Foundation.NSString forMode) cil managed" />
 
539
      <MemberType>Method</MemberType>
 
540
      <AssemblyInfo>
 
541
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
542
      </AssemblyInfo>
 
543
      <Attributes>
 
544
        <Attribute>
 
545
          <AttributeName>MonoMac.Foundation.Export("unscheduleFromRunLoop:forMode:")</AttributeName>
 
546
        </Attribute>
 
547
      </Attributes>
 
548
      <ReturnValue>
 
549
        <ReturnType>System.Void</ReturnType>
 
550
      </ReturnValue>
 
551
      <Parameters>
 
552
        <Parameter Name="aRunLoop" Type="MonoMac.Foundation.NSRunLoop" />
 
553
        <Parameter Name="forMode" Type="MonoMac.Foundation.NSString" />
 
554
      </Parameters>
 
555
      <Docs>
 
556
        <param name="aRunLoop">The run loop to unschedule.</param>
 
557
        <param name="forMode">The mode to unschedule.</param>
 
558
        <summary>Causes the connection to not use this run loop and mode.</summary>
 
559
        <remarks>
 
560
        </remarks>
 
561
      </Docs>
 
562
    </Member>
 
563
    <Member MemberName="Unschedule">
500
564
      <MemberSignature Language="C#" Value="public virtual void Unschedule (MonoMac.Foundation.NSRunLoop aRunLoop, string forMode);" />
501
565
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Unschedule(class MonoMac.Foundation.NSRunLoop aRunLoop, string forMode) cil managed" />
502
566
      <MemberType>Method</MemberType>
507
571
        <Attribute>
508
572
          <AttributeName>MonoMac.Foundation.Export("unscheduleFromRunLoop:forMode:")</AttributeName>
509
573
        </Attribute>
 
574
        <Attribute>
 
575
          <AttributeName>System.Obsolete("Use Unschedule (NSRunLoop, NSString) instead")</AttributeName>
 
576
        </Attribute>
510
577
      </Attributes>
511
578
      <ReturnValue>
512
579
        <ReturnType>System.Void</ReturnType>
516
583
        <Parameter Name="forMode" Type="System.String" />
517
584
      </Parameters>
518
585
      <Docs>
519
 
        <param name="aRunLoop">To be added.</param>
520
 
        <param name="forMode">To be added.</param>
521
 
        <summary>To be added.</summary>
522
 
        <remarks>To be added.</remarks>
 
586
        <param name="aRunLoop">The run loop to unschedule.</param>
 
587
        <param name="forMode">The mode to unschedule.</param>
 
588
        <summary>Causes the connection to not use this run loop and mode.</summary>
 
589
        <remarks>This method is obsolete. Use the Unschedule (NSRunLoop, NSString) overload instead.</remarks>
523
590
      </Docs>
524
591
    </Member>
525
592
    <Member MemberName="UseCredentials">