Gjsify LogoGjsify Logo

Opaque structure for holding in-progress action data.

record

Hierarchy

  • ServiceAction

Index

Constructors

Properties

name: string

Methods

  • getArgumentCount(): number
  • Get the number of IN arguments from the action and return it.

    Returns number

  • getLocales(): string[]
  • Get an ordered (preferred first) #GList of locales preferred by the client. Free list and elements after use.

    Returns string[]

  • Get the #SoupMessage associated with action. Mainly intended for applications to be able to read HTTP headers received from clients.

    Returns Soup.Message

  • getName(): string
  • getValue(argument: string, type: GType<unknown>): any
  • 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<unknown>

      The type of argument to retrieve

    Returns any

  • getValues(argNames: string[], argTypes: GType<unknown>[]): any[]
  • A variant of #gupnp_service_action_get that uses #GList instead of varargs.

    Parameters

    • argNames: string[]

      A #GList of argument names as string

    • argTypes: GType<unknown>[]

      A #GList of argument types as #GType

    Returns any[]

  • return(): void
  • returnError(errorCode: number, errorDescription: string): void
  • Return error_code.

    Parameters

    • errorCode: number

      The error code

    • errorDescription: 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

  • returnSuccess(): void
  • setValue(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 #GValue to store the return value

    Returns void

  • setValues(argNames: string[], argValues: any[]): void
  • Sets the specified action return values.

    Parameters

    • argNames: string[]

      A #GList of argument names

    • argValues: any[]

      The #GList of values (as #GValues) that line up with arg_names.

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method