mUPnP for C
CGUpnpAction Class Reference

#include <CGUpnpAction.h>

Inheritance diagram for CGUpnpAction:

Instance Methods

(id) - initWithCObject:
 
(NSString *) - name
 
(NSDictionary *) - arguments
 
(BOOL) - setArgumentValue:forName:
 
(NSString *) - argumentValueForName:
 
(BOOL) - post
 
(BOOL) - postWithArguments:
 
(NSInteger) - statusCode
 

Properties

mUpnpActioncObject
 

Detailed Description

The CGUpnpAction class is a wrapper class for mUpnpAction of mUPnP for C.

Method Documentation

◆ arguments

- (NSDictionary *) arguments

Get all arguments in the action as a NSDictionary object.

Returns
NSDictionary of the arguments.

◆ argumentValueForName:

- (NSString *) argumentValueForName: (NSString*) name

Get a value of the specified argument from the action by the argument's name directly.

Parameters
nameThe name of the argument to look for
Returns
The target value if successfull; otherwise NULL

◆ initWithCObject:

- (id) initWithCObject: (mUpnpAction*) cobj

◆ name

- (NSString *) name

Get the name of the action.

Returns
The name.

◆ post

- (BOOL) post

Send action

Returns
YES if successfull; otherwise NO

◆ postWithArguments:

- (BOOL) postWithArguments: (NSDictionary*) arguments

Send action

Parameters
argumentsArguments to set
Returns
YES if successfull; otherwise NO

◆ setArgumentValue:forName:

- (BOOL) setArgumentValue: (NSString*) value
forName: (NSString*) name 

Set a value of the specified argument from the action by the argument's name directly.

Parameters
valueThe value to set
nameThe name of the argument to look for
Returns
YES if successfull; otherwise NO

◆ statusCode

- (NSInteger) statusCode

Get a states code of the last post.

Returns
The status code

Property Documentation

◆ cObject

- (mUpnpAction*) cObject
readatomicassign

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