GUPnP.ServiceAction¶

Fields¶

None

Methods¶

	`get_argument_count` ()
	`get_locales` ()
	`get_message` ()
	`get_name` ()
	`get_value` (argument, type)
	`get_values` (arg_names, arg_types)
	`return_error` (error_code, error_description)
	`return_success` ()
	`set_value` (argument, value)
	`set_values` (arg_names, arg_values)

Details¶

class GUPnP.ServiceAction¶

Opaque structure for holding in-progress action data.

get_argument_count()¶

Returns:: The number of IN arguments from the self.
Return type:: int

Get the number of IN arguments from the self and return it.

New in version 0.18.0.

get_locales()¶

Returns:: A GLib.List of str locale names.
Return type:: [str]

Get an ordered (preferred first) GLib.List of locales preferred by the client. Free list and elements after use.

get_message()¶

Returns:: Soup.ServerMessage associated with self. Unref after using it.
Return type:: Soup.ServerMessage

Get the Soup.Message associated with self. Mainly intended for applications to be able to read HTTP headers received from clients.

New in version 0.14.0.

get_name()¶

Returns:: The name of self
Return type:: str

Get the name of self.

get_value(argument, type)¶

Parameters:

argument (str) – The name of the argument to retrieve
type (GObject.GType) – The type of argument to retrieve

Returns:

Value as GObject.Value associated with self. GObject.Value.unset() and g_slice_free() it after usage.

Return type:

GObject.Value

Retrieves the value of argument into a GObject.Value of type type and returns it. The method exists only and only to satify PyGI, please use GUPnP.ServiceAction.get_value() and ignore this if possible.

New in version 0.14.0.

get_values(arg_names, arg_types)¶

Parameters:

arg_names ([str]) – A GLib.List of argument names as string
arg_types ([GObject.GType]) – A GLib.List of argument types as GObject.GType

Returns:

The values as GLib.List of GObject.Value. g_list_free() the returned list and GObject.Value.unset() and g_slice_free() each element.

Return type:

[GObject.Value]

A variant of #gupnp_service_action_get that uses GLib.List instead of varargs.

New in version 0.14.0.

return_error(error_code, error_description)¶

Parameters:

error_code (int) – The error code
error_description (str) – The error description, or None if error_code is one of GUPnP.ControlError.INVALID_ACTION, GUPnP.ControlError.INVALID_ARGS, GUPnP.ControlError.OUT_OF_SYNC or GUPnP.ControlError.ACTION_FAILED, in which case a description is provided automatically.

Return error_code.

return_success()¶: Return successfully.

New in version 1.4.2.

set_value(argument, value)¶

Parameters:

argument (str) – The name of the return value to retrieve
value (GObject.Value) – The GObject.Value to store the return value

Sets the value of argument to value.

set_values(arg_names, arg_values)¶

Parameters:

arg_names ([str]) – A GLib.List of argument names
arg_values ([GObject.Value]) – The GLib.List of values (as GObject.Value s) that line up with arg_names.

Sets the specified action return values.

New in version 0.14.0.