GUPnP-1.6 ▶ GUPnP ▶ ServiceActionAbstract

constructor

• new ServiceAction(): ServiceAction

  Returns ServiceAction

Static$gtype

get_argument_count

• get_argument_count(): number

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

  Returns number

  The number of IN arguments from the action.

get_locales

• get_locales(): string[]

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

  Returns string[]

  A GLib.List of #char* locale names.

get_message

• get_message(): Soup.ServerMessage

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

  Returns Soup.ServerMessage

  Soup.ServerMessage associated with action. Unref after using it.

get_name

• get_name(): string

  Get the name of action.

  Returns string

  The name of action

get_value

• get_value(argument: string, type: GType): unknown

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

  Parameters

  • argument: string

    The name of the argument to retrieve

  • type: GType

    The type of argument to retrieve

  Returns unknown

  Value as GObject.Value associated with action. g_value_unset() and g_slice_free() it after usage.

get_values

• get_values(arg_names: string[], arg_types: GType<unknown>[]): unknown[]

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

  Parameters

  • arg_names: string[]

    A GLib.List of argument names as string

  • arg_types: GType<unknown>[]

    A GLib.List of argument types as GObject.GType

  Returns unknown[]

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

return_error

• return_error(error_code: number, error_description: string): void

  Return error_code.

  Parameters

  • error_code: number

    The error code

  • error_description: string

    The error description, or null if error_code is one of #GUPNP_CONTROL_ERROR_INVALID_ACTION, #GUPNP_CONTROL_ERROR_INVALID_ARGS, #GUPNP_CONTROL_ERROR_OUT_OF_SYNC or #GUPNP_CONTROL_ERROR_ACTION_FAILED, in which case a description is provided automatically.

  Returns void

return_success

• return_success(): void

  Return successfully.

  Returns void

set_value

• set_value(argument: string, value: any): void

  Sets the value of argument to value.

  Parameters

  • argument: string

    The name of the return value to retrieve

  • value: any

    The GObject.Value to store the return value

  Returns void

set_values

• set_values(arg_names: string[], arg_values: any[]): void

  Sets the specified action return values.

  Parameters

  • arg_names: string[]

    A GLib.List of argument names

  • arg_values: any[]

    The GLib.List of values (as GObject.Values) that line up with arg_names.

  Returns void