Module "dns_action"
Description
DNS_Action Module
This module allows you to access DNS_Actions. These are objects which
are generated when requesting a transfer. They can be frozen in time
if they need more information to complete their task. A good example is
a domain name transfer requiring a confirmation via an authorization
code or even via fax.
Available methods
- void confirm
- void fail
- array get_by_domain_tld_uncompleted
- array get_by_id
- array get_by_user
- array get_by_user_uncompleted
Details
void confirm
Confirm a DNS_Action
The $data variable can contain an array which could supply the
DNS_Action with all the required info to complete its taks.
Parameters
- int $id The ID of the DNS_Action to confirm
- array $data An array containing optional data
void fail
Fail a DNS_Action
If you want to cancel a transfer for some reason, this is the
method you should call.
Parameters
- int $id The ID of the DNS_Action to fail
array get_by_domain_tld_uncompleted
Get an uncompleted DNS_Action by its domain name and tld
Parameters
- string $domain The domain name of the DNS_Action
- string $tld The tld of the DNS_Action
Returns
- array $info An array containing all the information of this DNS_Action
array get_by_id
Get all the information associated with a DNS_Action by supplying
its ID
Parameters
- int $id The ID of the DNS_Action to retrieve
Returns
- array $info An array containing all the information of this DNS_Action
array get_by_user
Get all DNS_Actions for a user
Parameters
- int $user_id The ID of the User for which to retrieve DNS_Actions
Returns
- array $dns_actions An array containing all the DNS actions
array get_by_user_uncompleted
Get all uncompleted DNS_Actions for a user
Parameters
- int $user_id The ID of the User for which to retrieve uncompleted DNS_Actions
Returns
- array $dns_actions An array containing all the uncompleted DNS actions