HIDParameter Class Reference

Represents a parameter or option where the ID and value are enforced to be of type NSString. More...

#import <HIDParameter.h>

Inheritance diagram for HIDParameter:

Instance Methods
(id)	- initWithString:forKey:
	Initializes an instance of parameter with specified key and value. More...

Class Methods
(id)	+ parameterWithString:forKey:
	Creates an instance of parameter with specified key and value. More...

Properties
HIDParameterEncoding	encoding
	The parameter encoding.
NSString *	key
	The parameter key.
HIDParameterType	type
	The parameter type.
NSString *	value
	The parameter value.

Detailed Description

Represents a parameter or option where the ID and value are enforced to be of type NSString.

A type and encoding attribute are also available to represent more complex data that is to be sent or received. These might be useful, for example, when transporting a complex binary object.

Example: For an ASN.1-encoded RSA private key the Parameter may be:

• type = "CRMF.EncryptedValue" (or an OID if available)
• encoding = "base64Binary"

Method Documentation

- (id) initWithString:		(NSString *)	value
forKey:		(NSString *)	key

Initializes an instance of parameter with specified key and value.

Parameters

value	the parameter value.
key	the parameter key.

Returns

an instance of HIDParameter.

Encoding is HIDParameterEncodingNone (HIDParameterEncoding) and type is HIDParameterTypeString (HIDParameterType).

+ (id) parameterWithString:		(NSString *)	value
forKey:		(NSString *)	key

Creates an instance of parameter with specified key and value.

Parameters

value	the parameter value.
key	the parameter key.

Returns

an instance of HIDParameter.

Encoding is HIDParameterEncodingNone (HIDParameterEncoding) and type is HIDParameterTypeString (HIDParameterType).

---

The documentation for this class was generated from the following file:

• HIDParameter.h