Ags.MessageEnvelope¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (sender, recipient, doc)
class	`new_with_params` (sender, recipient, doc, n_params, parameter_name, value)
	`get_doc` ()
	`get_parameter` (n_params, parameter_name, value)
	`get_recipient` ()
	`get_sender` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`recipient`	`GObject.Object`	r/w	The recipient of message envelope
`sender`	`GObject.Object`	r/w	The sender of message envelope
`xml-doc`	`int`	r/w	The xml document provided by message envelope

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access
doc	`libxml2.Doc`	r
free_func	`GLib.DestroyNotify`	r
gobject	`GObject.Object`	r
n_params	`int`	r
obj_mutex	`GLib.RecMutex`	r
parameter_name	`str`	r
recipient	`GObject.Object`	r
sender	`GObject.Object`	r
value	`GObject.Value`	r

Class Details¶

class Ags.MessageEnvelope(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Ags.MessageEnvelopeClass

classmethod new(sender, recipient, doc)¶

Parameters:

sender (GObject.Object) – the GObject.Object as sender
recipient (GObject.Object) – the GObject.Object as recipient
doc (libxml2.Doc) – the libxml2.Doc

Returns:

the new Ags.MessageEnvelope

Return type:

Ags.MessageEnvelope

Create a new instance of Ags.MessageEnvelope.

New in version 3.0.0.

classmethod new_with_params(sender, recipient, doc, n_params, parameter_name, value)¶

Parameters:

sender (GObject.Object) – the GObject.Object as sender
recipient (GObject.Object) – the GObject.Object as recipient
doc (libxml2.Doc) – the libxml2.Doc
n_params (int) – n params
parameter_name (str) – None terminated string vector containing parameter names
value (GObject.Value) – the GObject.Value-struct array containing values

Returns:

the new Ags.MessageEnvelope

Return type:

Ags.MessageEnvelope

Create a new instance of Ags.MessageEnvelope.

New in version 3.0.0.

get_doc()¶

Returns:: the doc
Return type:: libxml2.Doc

Get libxml2.Doc.

New in version 3.0.0.

get_parameter(n_params, parameter_name, value)¶

Parameters:

n_params (int) – return location of parameter count
parameter_name (str) – return location None terminated string vector containing parameter name
value (GObject.Value) – return location of GObject.Value-struct array containing values

Get parameters.

New in version 3.0.0.

get_recipient()¶

Returns:: the recipient
Return type:: GObject.Object

Get recipient.

New in version 3.0.0.

get_sender()¶

Returns:: the sender
Return type:: GObject.Object

Get sender.

New in version 3.0.0.

Property Details¶

Ags.MessageEnvelope.props.recipient¶

Name:: recipient
Type:: GObject.Object
Default Value:: None
Flags:: READABLE, WRITABLE

The assigned recipient.

New in version 3.0.0.

Ags.MessageEnvelope.props.sender¶

Name:: sender
Type:: GObject.Object
Default Value:: None
Flags:: READABLE, WRITABLE

The assigned sender.

New in version 3.0.0.

Ags.MessageEnvelope.props.xml_doc¶

Name:: xml-doc
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE

The assigned xml-doc.

New in version 3.0.0.