FV_API
[ class tree: FV_API ] [ index: FV_API ] [ all elements ]
Packages:
FV_API


Files:
ApiConnector.php
ApiIncludes.php
ChangePasswordCommand.php
Command.php
Configuration.php
DeleteDnsRecordCommand.php
DeleteForwarderCommand.php
DeleteMailboxCommand.php
DisableAutoresponderCommand.php
DisplayIdentityCommand.php
EnableAutoresponderCommand.php
ListDnsRecordsCommand.php
ListDomainsCommand.php
ListForwardersCommand.php
ListFtpUsersCommand.php
ListMailboxesCommand.php
LoginCommand.php
LoginSwitchUserCommand.php
LogoutCommand.php
LookupDomainWhoisCommand.php
NewForwarderCommand.php
NewMailboxCommand.php
ResetDomainNameserversCommand.php
SetDomainNameserversCommand.php
SetDomainRegistrantDetailsCommand.php
SetForwarderDestinationCommand.php
SetMailboxPasswordCommand.php
ShowDomainCommand.php
ShowDomainMailPolicyCommand.php
ShowDomainNameserversCommand.php
ShowDomainRegistrantDetailsCommand.php
ShowForwarderCommand.php
ShowMailboxCommand.php

Interfaces:
Command
Classes:
AccessDeniedException
AddressRecord
CanonicalNameRecord
ChangePasswordCommand
ConnectionException
DeleteDnsRecordCommand
DeleteForwarderCommand
DeleteMailboxCommand
DisableAutoresponderCommand
DisplayIdentityCommand
DomainAttribute
DomainPolicyForward
DomainPolicyRefuse
DomainPolicyRewrite
DomainPolicySmtpRoute
EnableAutoresponderCommand
InternalErrorException
InvalidRequestException
ListDnsRecordsCommand
ListDomainsCommand
ListForwardersCommand
ListFtpUsersCommand
ListMailboxesCommand
LoginCommand
LoginRequiredException
LoginSwitchUserCommand
LogoutCommand
LookupDomainWhoisCommand
MailExchangeRecord
MalformedRequestException
Nameserver
NameserverRecord
NewForwarderCommand
NewMailboxCommand
Record
RequestGenerator
ResetDomainNameserversCommand
SetDomainNameserversCommand
SetDomainRegistrantDetailsCommand
SetForwarderDestinationCommand
SetMailboxPasswordCommand
ShowDomainCommand
ShowDomainMailPolicyCommand
ShowDomainNameserversCommand
ShowDomainRegistrantDetailsCommand
ShowForwarderCommand
ShowMailboxCommand
SSLRequiredException
TextRecord
UnexpectedStatusException

Class: LoginSwitchUserCommand

Source Location: /commands/intrinsic/LoginSwitchUserCommand.php

Class Overview




Logins in as one API account; then immediately switches the current user to a different user.









                

            Implements interfaces:
            

        

        






Methods
























Class Details



[line 10]

Logins in as one API account; then immediately switches the current user to a different user.

This is useful for web hosting resellers or any other business situation where you wish to use login as under your own API account but have the API system assume the identity of a different user.  This will typically be the first command issued in any session.





[ Top ]








Class Methods




  

	
	
constructor __construct [line 39]

	

    

    

		LoginSwitchUserCommand __construct(

$accountName, 
$emailAddress, 
$password, 
$switch_user_email_address, 
$switch_user_password)
    

    


	
		



Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

          
        $accountName  
        
      

          

          
        $emailAddress  
        
      

          

          
        $password  
        
      

          

          
        $switch_user_email_address  
        
      

          

          
        $switch_user_password  
        
      

        

    


        
[ Top ]

  

  

	
	
method commandName [line 48]

	

    

    

		void commandName(
)
    

    


	
		



Tags:





  

    access:  public
  









			

		
Implementation of:

			

			
Command::commandName()

						
Name of the command

					

		
        
[ Top ]

  

  

	
	
method getEmailAddress [line 95]

	

    

    

		void getEmailAddress(
)
    

    


	
		



Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getFID [line 80]

	

    

    

		void getFID(
)
    

    


	
		



Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getFVN [line 85]

	

    

    

		void getFVN(
)
    

    


	
		



Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getName [line 90]

	

    

    

		void getName(
)
    

    


	
		



Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getToken [line 75]

	

    

    

		void getToken(
)
    

    


	
		



Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method parseRequest [line 58]

	

    

    

		void parseRequest(
RequestGenerator
$req)
    

    


	
		



Tags:





  

    access:  public
  









			

		
Implementation of:

			

			
Command::parseRequest()

						
Used to convert the command into a request we can issue to the FastVision API reseller servers.

					

		
        
Parameters:

    

    

          

        RequestGenerator  
        $req  
        
      

        

    


        
[ Top ]

  

  

	
	
method parseResponse [line 67]

	

    

    

		void parseResponse(

$xml)
    

    


	
		



Tags:





  

    access:  public
  









			

		
Implementation of:

			

			
Command::parseResponse()

						
Used to convert the response command into a request we can issue to the FastVision API reseller servers.

					

		
        
Parameters:

    

    

          

        SimpleXMLElement  
        $xml  
        
      

        

    


        
[ Top ]

  

  

	
	
method requiresAuthentication [line 53]

	

    

    

		void requiresAuthentication(
)
    

    


	
		



Tags:





  

    access:  public
  









			

		
Implementation of:

			

			
Command::requiresAuthentication()

						
Does the connection need to be authenticated prior to issuing this command? (Boolean)

					

		
        
[ Top ]

  






        

		    

		    Documentation generated on Mon, 30 Mar 2009 16:34:37 +0100 by phpDocumentor 1.4.1