Infinity.AclAccount¶
Fields¶
Name |
Type |
Access |
Description |
|---|---|---|---|
id |
r/w |
A unique ID for this account. |
|
name |
r/w |
A human readable account name. |
Methods¶
class |
|
class |
|
class |
|
class |
|
|
|
|
|
|
Details¶
- class Infinity.AclAccount¶
This boxed type specifies basic user account information.
- classmethod array_free(accounts)¶
- Parameters:
accounts ([
Infinity.AclAccount]) – An array ofInfinity.AclAccountobjects.
Releases all resources allocated by an array of
Infinity.AclAccounts.
- classmethod from_xml(xml)¶
- Parameters:
xml (
libxml2.NodePtr) – An XML node.- Raises:
- Returns:
A new
Infinity.AclAccounton success, orNoneon failure. Free withInfinity.AclAccount.free() when no longer needed.- Return type:
Attempts to deserialize an
Infinity.AclAccountthat was written to an XML node by the functionInfinity.AclAccount.to_xml(). If an error occurs, such as mandatory fields being missing, the function returnsNoneand error is set.
- classmethod id_to_string(account)¶
- Parameters:
account (
int) – A #InfAclAccountId.- Returns:
A string representation of the given account ID, or
Noneif the account does not exist. The return value must not be freed.- Return type:
Translates the given account ID to a unique string identifier.
- classmethod new(id, name)¶
- Parameters:
- Returns:
A new
Infinity.AclAccountobject.- Return type:
Creates a new
Infinity.AclAccount.
- copy()¶
- Returns:
A new
Infinity.AclAccount. Free withInfinity.AclAccount.free() when no longer needed.- Return type:
Creates a copy of self.
- free()¶
Releases all resources allocated by self.
- to_xml(xml)¶
- Parameters:
xml (
libxml2.NodePtr) – The XML node to write the account attributes to.
Serializes the properties of self into the XML node xml. The function
Infinity.AclAccount.from_xml() does the reverse operation and deserializes the account object from the XML.