NSHttpCookie Constructors
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| NSHttpCookie(NSDictionary) |
Creates a new NSHttpCookie |
| NSHttpCookie(NSObjectFlag) |
Constructor to call on derived classes to skip initialization and merely allocate the object. |
| NSHttpCookie(IntPtr) |
A constructor used when creating managed representations of unmanaged objects; Called by the runtime. |
| NSHttpCookie(Cookie) |
Create a new cookie from the supplied System.Net.Cookie instance properties |
| NSHttpCookie(String, String) |
Create a new cookie with the supplied name and value. |
| NSHttpCookie(String, String, String) |
Create a new cookie with the supplied name, value and path. |
| NSHttpCookie(String, String, String, String) |
Create a new cookie with the supplied name, value, path and domain. |
NSHttpCookie(NSDictionary)
Creates a new NSHttpCookie
[Foundation.Export("initWithProperties:")]
public NSHttpCookie (Foundation.NSDictionary properties);new Foundation.NSHttpCookie : Foundation.NSDictionary -> Foundation.NSHttpCookieParameters
- properties
- NSDictionary
Dictionary with the cookie values.
- Attributes
Remarks
To instantiate instances of NSHTTPCookie you need to pass an NSDictionary
The actual keys have to be one the public Key static fields from this class (KeyName, KeyValue, KeyOriginUrl, KeyVersion, KeyDomain, KeyPath, KeySecure, KeyExpires, KeyComment, KeyCommentUrl, KeyDiscard, KeyMaximumAge and KeyPort).
var properties = NSDictionary.FromObjectsAndKeys (new object [] { "MyCookieValue" }, new object [] { NSHttpCookie.KeyValue });
var cookie = new NSHttpCookie (properties);
Applies to
NSHttpCookie(NSObjectFlag)
Constructor to call on derived classes to skip initialization and merely allocate the object.
protected NSHttpCookie (Foundation.NSObjectFlag t);new Foundation.NSHttpCookie : Foundation.NSObjectFlag -> Foundation.NSHttpCookieParameters
Unused sentinel value, pass NSObjectFlag.Empty.
Remarks
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.
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.
It is the developer's responsibility to completely initialize the object if they chain up using the NSObjectFlag.Empty path.
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.
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:
//
// 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);
}
Applies to
NSHttpCookie(IntPtr)
A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
protected internal NSHttpCookie (IntPtr handle);new Foundation.NSHttpCookie : nativeint -> Foundation.NSHttpCookieParameters
- handle
-
IntPtr
nativeint
Pointer (handle) to the unmanaged object.
Remarks
This constructor is invoked by the runtime infrastructure (GetNSObject(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.
Applies to
NSHttpCookie(Cookie)
Create a new cookie from the supplied System.Net.Cookie instance properties
public NSHttpCookie (System.Net.Cookie cookie);new Foundation.NSHttpCookie : System.Net.Cookie -> Foundation.NSHttpCookieParameters
- cookie
- Cookie
An existing Cookie from the .NET framework
Remarks
This constructor will throw an ArgumentNullException if cookie is null
Applies to
NSHttpCookie(String, String)
Create a new cookie with the supplied name and value.
public NSHttpCookie (string name, string value);new Foundation.NSHttpCookie : string * string -> Foundation.NSHttpCookieParameters
- name
- String
Cookie's name. Cannot be null.
- value
- String
Cookie's value. Cannot be null.
Remarks
A default Path and Domain will be used to ensure a valid instance is created.
Applies to
NSHttpCookie(String, String, String)
Create a new cookie with the supplied name, value and path.
public NSHttpCookie (string name, string value, string path);new Foundation.NSHttpCookie : string * string * string -> Foundation.NSHttpCookieParameters
- name
- String
Cookie's name. Cannot be null.
- value
- String
Cookie's value. Cannot be null.
- path
- String
Path where the cookie will be applied on the domain. Using "/" will send the cookie to every URL on the domain.
Remarks
A default Domain will be used to ensure a valid instance is created
Applies to
NSHttpCookie(String, String, String, String)
Create a new cookie with the supplied name, value, path and domain.
public NSHttpCookie (string name, string value, string path, string domain);new Foundation.NSHttpCookie : string * string * string * string -> Foundation.NSHttpCookieParameters
- name
- String
Cookie's name. Cannot be null.
- value
- String
Cookie's value. Cannot be null.
- path
- String
Path where the cookie will be applied on the domain. Using "/" will send the cookie to every URL on the domain.
- domain
- String
Domain (e.g. xamarin.com) related to the cookie
Remarks
An ArgumentNullException will be thrown if either name or value are null.