Infinity.RequestResult¶

Fields¶

None

Methods¶

class	`make_add_node` (browser, iter, new_node)
class	`make_create_acl_account` (browser, account, certificate)
class	`make_explore_node` (browser, iter)
class	`make_join_user` (proxy, user)
class	`make_lookup_acl_accounts` (browser, accounts)
class	`make_query_acl` (browser, iter, sheet_set)
class	`make_query_acl_account_list` (browser, accounts, does_notifications)
class	`make_remove_acl_account` (browser, account)
class	`make_remove_node` (browser, iter)
class	`make_save_session` (browser, iter)
class	`make_set_acl` (browser, iter)
class	`make_subscribe_chat` (browser, proxy)
class	`make_subscribe_session` (browser, iter, proxy)
class	`new` (data, len)
	`copy` ()
	`free` ()
	`get` ()
	`get_add_node` ()
	`get_create_acl_account` ()
	`get_explore_node` ()
	`get_join_user` ()
	`get_lookup_acl_accounts` ()
	`get_query_acl` ()
	`get_query_acl_account_list` (does_notifications)
	`get_remove_acl_account` ()
	`get_remove_node` ()
	`get_save_session` ()
	`get_set_acl` ()
	`get_subscribe_chat` ()
	`get_subscribe_session` ()

Details¶

class Infinity.RequestResult¶

Infinity.RequestResult is an opaque data type. You should only access it via the public API functions.

classmethod make_add_node(browser, iter, new_node)¶

Parameters:	browser (`Infinity.Browser`) – A `Infinity.Browser`. iter (`Infinity.BrowserIter`) – An iterator pointing to the node to which a node has been added. new_node (`Infinity.BrowserIter`) – An iterator pointing to the new node.
Returns:	A new `Infinity.RequestResult`. Free with `Infinity.RequestResult.free`().
Return type:	`Infinity.RequestResult`

Creates a new Infinity.RequestResult for an “add-node” request, see Infinity.Browser.add_note() or Infinity.Browser.add_subdirectory(). The Infinity.RequestResult object is only valid as long as the caller maintains a reference to browser.

classmethod make_create_acl_account(browser, account, certificate)¶

Parameters:	browser (`Infinity.Browser`) – A `Infinity.Browser`. account (`Infinity.AclAccount`) – The created `Infinity.AclAccount`. certificate (`Infinity.CertificateChain`) – The certificate which can be used to log into account.
Returns:	A new `Infinity.RequestResult`. Free with `Infinity.RequestResult.free`().
Return type:	`Infinity.RequestResult`

Creates a new Infinity.RequestResult for a “create-acl-account” request, see Infinity.Browser.create_acl_account(). The Infinity.RequestResult object is only valid as long as the caller maintains a reference to browser.

classmethod make_explore_node(browser, iter)¶

Parameters:	browser (`Infinity.Browser`) – A `Infinity.Browser`. iter (`Infinity.BrowserIter`) – An iterator pointing to the node to which was explored.
Returns:	A new `Infinity.RequestResult`. Free with `Infinity.RequestResult.free`().
Return type:	`Infinity.RequestResult`

Creates a new Infinity.RequestResult for an “explore-node” request, see Infinity.Browser.explore(). The Infinity.RequestResult object is only valid as long as the caller maintains a reference to browser.

classmethod make_join_user(proxy, user)¶

Parameters:	proxy (`Infinity.SessionProxy`) – A `Infinity.SessionProxy`. user (`Infinity.User`) – The joined user.
Returns:	A new `Infinity.RequestResult`. Free with `Infinity.RequestResult.free`().
Return type:	`Infinity.RequestResult`

Creates a new Infinity.RequestResult for a “join-user” request, see Infinity.SessionProxy.join_user(). The Infinity.RequestResult object is only valid as long as the caller maintains a reference to proxy.

classmethod make_lookup_acl_accounts(browser, accounts)¶

Parameters:	browser (`Infinity.Browser`) – A `Infinity.Browser`. accounts ([`Infinity.AclAccount`]) – The list of accounts.
Returns:	A new `Infinity.RequestResult`. Free with `Infinity.RequestResult.free`().
Return type:	`Infinity.RequestResult`

Creates a new Infinity.RequestResult for a “lookup-acl-accounts” request, see Infinity.Browser.lookup_acl_accounts(). The Infinity.RequestResult object is only valid as long as the caller maintains a reference to browser.

classmethod make_query_acl(browser, iter, sheet_set)¶

Parameters:	browser (`Infinity.Browser`) – A `Infinity.Browser`. iter (`Infinity.BrowserIter`) – An iterator pointing to the node whose ACL was queried. sheet_set (`Infinity.AclSheetSet`) – The sheet set for the queried node.
Returns:	A new `Infinity.RequestResult`. Free with `Infinity.RequestResult.free`().
Return type:	`Infinity.RequestResult`

Creates a new Infinity.RequestResult for a “query-acl” request, see Infinity.Browser.query_acl(). The Infinity.RequestResult object is only valid as long as the caller maintains a reference to browser and proxy.

classmethod make_query_acl_account_list(browser, accounts, does_notifications)¶

Parameters:	browser (`Infinity.Browser`) – A `Infinity.Browser`. accounts ([`Infinity.AclAccount`]) – The list of accounts. does_notifications (`bool`) – Whether the server notifies the clients about added or removed accounts.
Returns:	A new `Infinity.RequestResult`. Free with `Infinity.RequestResult.free`().
Return type:	`Infinity.RequestResult`

Creates a new Infinity.RequestResult for a “query-acl-account-list” request, see Infinity.Browser.query_acl_account_list(). The Infinity.RequestResult object is only valid as long as the caller maintains a reference to browser.

classmethod make_remove_acl_account(browser, account)¶

Parameters:	browser (`Infinity.Browser`) – A `Infinity.Browser`. account (`Infinity.AclAccount`) – The removed `Infinity.AclAccount`.
Returns:	A new `Infinity.RequestResult`. Free with `Infinity.RequestResult.free`().
Return type:	`Infinity.RequestResult`

Creates a new Infinity.RequestResult for a “remove-acl-account” request, see Infinity.Browser.remove_acl_account(). The Infinity.RequestResult object is only valid as long as the caller maintains a reference to browser.

classmethod make_remove_node(browser, iter)¶

Parameters:	browser (`Infinity.Browser`) – A `Infinity.Browser`. iter (`Infinity.BrowserIter`) – An iterator pointing to the node to which was removed.
Returns:	A new `Infinity.RequestResult`. Free with `Infinity.RequestResult.free`().
Return type:	`Infinity.RequestResult`

Creates a new Infinity.RequestResult for an “remove-node” request, see Infinity.Browser.remove_node(). The Infinity.RequestResult object is only valid as long as the caller maintains a reference to browser.

classmethod make_save_session(browser, iter)¶

Parameters:	browser (`Infinity.Browser`) – A `Infinity.Browser`. iter (`Infinity.BrowserIter`) – An iterator pointing to the node to which was saved.
Returns:	A new `Infinity.RequestResult`. Free with `Infinity.RequestResult.free`().
Return type:	`Infinity.RequestResult`

Creates a new Infinity.RequestResult for a “save-session” request, see infc_browser_iter_save_session(). The Infinity.RequestResult object is only valid as long as the caller maintains a reference to browser.

classmethod make_set_acl(browser, iter)¶

Parameters:	browser (`Infinity.Browser`) – A `Infinity.Browser`. iter (`Infinity.BrowserIter`) – An iterator pointing to the node whose ACL was set.
Returns:	A new `Infinity.RequestResult`. Free with `Infinity.RequestResult.free`().
Return type:	`Infinity.RequestResult`

Creates a new Infinity.RequestResult for a “set-acl” request, see Infinity.Browser.set_acl(). The Infinity.RequestResult object is only valid as long as the caller maintains a reference to browser and proxy.

classmethod make_subscribe_chat(browser, proxy)¶

Parameters:	browser (`Infinity.Browser`) – A `Infinity.Browser`. proxy (`Infinity.SessionProxy`) – The `Infinity.SessionProxy` for the subscribed session.
Returns:	A new `Infinity.RequestResult`. Free with `Infinity.RequestResult.free`().
Return type:	`Infinity.RequestResult`

Creates a new Infinity.RequestResult for a “subscribe-chat” request, see infc_browser_subscribe_chat(). The Infinity.RequestResult object is only valid as long as the caller maintains a reference to browser and proxy.

classmethod make_subscribe_session(browser, iter, proxy)¶

Parameters:	browser (`Infinity.Browser`) – A `Infinity.Browser`. iter (`Infinity.BrowserIter`) – An iterator pointing to the node to which a subscription was made. proxy (`Infinity.SessionProxy`) – The `Infinity.SessionProxy` for the subscription.
Returns:	A new `Infinity.RequestResult`. Free with `Infinity.RequestResult.free`().
Return type:	`Infinity.RequestResult`

Creates a new Infinity.RequestResult for a “subscribe-session” request, see Infinity.Browser.subscribe(). The Infinity.RequestResult object is only valid as long as the caller maintains a reference to browser and proxy.

classmethod new(data, len)¶

Parameters:	data (`object` or `None`) – The data representing the result of the request. len (`int`) – The length of the data.
Returns:	A new `Infinity.RequestResult`. Free with `Infinity.RequestResult.free`().
Return type:	`Infinity.RequestResult`

This function creates a new Infinity.RequestResult with the given data. The function takes ownership of the data which must have been allocated with GLib.malloc(). The memory segment at data must not hold any object references or require deinitialization in a way other than with GLib.free().

Under normal circumstances, this function should not be used, and instead one of the inf_request_result_make_*() functions should be used.

copy()¶

Returns:	A new `Infinity.RequestResult`. Free with `Infinity.RequestResult.free`().
Return type:	`Infinity.RequestResult`

Creates a copy of self.

free()¶: Releases all resources associated with self.

get()¶

Returns:	A pointer to the request data.
Return type:	`bytes`

Returns the data of self, as given to Infinity.RequestResult.new(). The length of the data is stored in length. Normally this function does not need to be used and one of the inf_request_result_get_*() functions should be used instead.

get_add_node()¶

Returns:

browser:	Output value of the browser that made the request, or `None`.
iter:	Output value for the node to which a node has been added, or `None`.
new_node:	Output value for the new node, or `None`.

Return type: (browser: Infinity.Browser, iter: Infinity.BrowserIter, new_node: Infinity.BrowserIter)

Decomposes self into its components. The object must have been created with Infinity.RequestResult.make_add_node().

get_create_acl_account()¶

Returns:

browser:	Output value of the browser that made the request, or `None`.
account:	Output value for the created `Infinity.AclAccount`, or `None`.
certificate:	Output value for the certificate which can be used to log into the account, or `None`.

Return type: (browser: Infinity.Browser, account: Infinity.AclAccount, certificate: Infinity.CertificateChain)

Decomposes self into its components. The object must have been created with Infinity.RequestResult.make_create_acl_account().

get_explore_node()¶

Returns:

browser:	Output value of the browser that made the request, or `None`.
iter:	Output value for the node that has been explored, or `None`.

Return type: (browser: Infinity.Browser, iter: Infinity.BrowserIter)

Decomposes self into its components. The object must have been created with Infinity.RequestResult.make_explore_node().

get_join_user()¶

Returns:

proxy:	Output value of the session proxy that made the request, or `None`.
user:	Output value for the joined user.

Return type: (proxy: Infinity.SessionProxy, user: Infinity.User)

Decomposes self into its components. The object must have been created with Infinity.RequestResult.make_join_user().

get_lookup_acl_accounts()¶

Returns:

browser:	Output value of the browser that made the request, or `None`.
accounts:	Output value for the list of accounts, or `None`.

Return type: (browser: Infinity.Browser, accounts: [Infinity.AclAccount])

Decomposes self into its components. The object must have been created with Infinity.RequestResult.make_lookup_acl_accounts().

get_query_acl()¶

Returns:

browser:	Output value of the browser that made the request, or `None`.
iter:	Output value for the node whose ACL was queried.
sheet_set:	Output value for the node’s ACL sheets.

Return type: (browser: Infinity.Browser, iter: Infinity.BrowserIter, sheet_set: Infinity.AclSheetSet)

Decomposes self into its components. The object must have been created with Infinity.RequestResult.make_query_acl().

get_query_acl_account_list(does_notifications)¶

Parameters: does_notifications (bool) – Output value for the flag whether the server notifies the client about added or removed accounts, or None.

Returns:

browser:	Output value of the browser that made the request, or `None`.
accounts:	Output value for the list of accounts, or `None`.

Return type: (browser: Infinity.Browser, accounts: [Infinity.AclAccount])

Decomposes self into its components. The object must have been created with Infinity.RequestResult.make_query_acl_account_list().

get_remove_acl_account()¶

Returns:

browser:	Output value of the browser that made the request, or `None`.
account:	Output value for the removed `Infinity.AclAccount`, or `None`.

Return type: (browser: Infinity.Browser, account: Infinity.AclAccount)

Decomposes self into its components. The object must have been created with Infinity.RequestResult.make_remove_acl_account().

get_remove_node()¶

Returns:

browser:	Output value of the browser that made the request, or `None`.
iter:	Output value for the node that has been removed, or `None`.

Return type: (browser: Infinity.Browser, iter: Infinity.BrowserIter)

Decomposes self into its components. The object must have been created with Infinity.RequestResult.make_remove_node().

get_save_session()¶

Returns:

browser:	Output value of the browser that made the request, or `None`.
iter:	Output value for the node that has been saved, or `None`.

Return type: (browser: Infinity.Browser, iter: Infinity.BrowserIter)

Decomposes self into its components. The object must have been created with Infinity.RequestResult.make_save_session().

get_set_acl()¶

Returns:

browser:	Output value of the browser that made the request, or `None`.
iter:	Output value for the node whose ACL was set.

Return type: (browser: Infinity.Browser, iter: Infinity.BrowserIter)

Decomposes self into its components. The object must have been created with Infinity.RequestResult.make_set_acl().

get_subscribe_chat()¶

Returns:

browser:	Output value of the browser that made the request, or `None`.
proxy:	Output value for the subscribed session’s proxy, or `None`.

Return type: (browser: Infinity.Browser, proxy: Infinity.SessionProxy)

Decomposes self into its components. The object must have been created with Infinity.RequestResult.make_subscribe_chat().

get_subscribe_session()¶

Returns:

browser:	Output value of the browser that made the request, or `None`.
iter:	Output value for the node that has been subscribed to, or `None`.
proxy:	Output value for the subscribed session’s proxy, or `None`.

Return type: (browser: Infinity.Browser, iter: Infinity.BrowserIter, proxy: Infinity.SessionProxy)

Decomposes self into its components. The object must have been created with Infinity.RequestResult.make_subscribe_session().