Class Veriplace_LocationUpdates

Description
Description | Methods (details)

A result set returned by Veriplace_PollingAPI::getUpdates.

This data structure represents location updates that occurred within a given time interval whose details can be queried by the current application.

  • property-read: DateTime $updatedTime: The ending date and time of the update query.
  • property-read: DateTime $sinceTime: The starting date and time of the update query.
  • property-read: int $period: The minimum time interval, in seconds, of location updates included in this result set.
  • property-read: array $users: An array of all the Veriplace user identifiers (Veriplace_User) in this result set.
  • property-read: array $availablePeriods: An array of all the allowable values for Veriplace_PollingAPI::$periodSeconds.
  • since: 1.3

Located in /Veriplace/Types.php (line 899) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

																															
				

					 
											Veriplace_LocationUpdates
										__construct
											( $updatedTime,  $sinceTime,  $period,  $updates,  $availablePeriods)
									

															
				

					 
											void
										getUpdatesForUser
											(Veriplace_User $user)
									

											

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		
		Constructor __construct (line 907)
	
 
	
	
	
    
				
  • access: public
    • 
			

	
	

		Veriplace_LocationUpdates
		
			__construct
		
					( $updatedTime,  $sinceTime,  $period,  $updates,  $availablePeriods)
			

	
			
    
					
  • 
				DateTime
				$updatedTime			
    • 
					
  • 
				DateTime
				$sinceTime			
    • 
					
  • 
				
				$period			
    • 
					
  • 
				array
				$updates			
    • 
					
  • 
				array
				$availablePeriods			
    • 
				

		
			
	




	
	

		
		getUpdatesForUser (line 922)
	
 
	
	

Returns a list of all the location update identifiers (which can be  passed to Veriplace_PollingAPI::getUpdateLocation) for the  given user in this result set, or an empty array if the user had no  updates.

	
    
				
  • access: public
    • 
			

	
	

		void
		
			getUpdatesForUser
		
					(Veriplace_User $user)
			

	
			
		
			
	

						
		

	


	
	

		Documentation generated on Sun, 29 Aug 2010 04:08:40 -0700 by phpDocumentor 1.4.1