AF SDK Reference

AFCollectiveMember Properties

Save PDF

TABLE OF CONTENTS

AFCollectiveMember Properties

Save PDF

Last UpdatedNov 18, 2025
4 minute read

The AFCollectiveMember type exposes the following members.

Properties

	Name	Description
	AccountName	This property is the account name that the PI AF Server for this AFCollectiveMember is executing under.
	Collective	The AFCollective that owns the collective member.
	CommunicationsGracePeriod	The communication grace period before the CommunicationStatus is set to TimedOutOnPrimary when there has not been any communication with the primary server.
	CommunicationsPeriod	The communication period that the collective members use to determine each others status.
	CommunicationStatus	The status of the communication between the members of the collective.
	CredentialsAccountName	Obsolete. The account name used by the collective member to access primary server.
	DatabaseVersion	Read-only property that contains a string that uniquely identifies the current database version.
	Description	Read/write property that provides a more detailed description of the object.
	Host	This property is the name of the host machine where the PI AF Server for this AFCollectiveMember is executing.
	ID	Read-only property that provides a unique identifier for the object to be used for quick access that is not dependent upon the index. (Inherited from AFObject.)
	Identity	This read-only property contains identity of the object. (Inherited from AFObject.)
	IsAvailable	Indicates if the collective member is available.
	IsConnected	Indicates if the collective member is being used as the connection to the PI AF Server.
	IsConnectedToPrimary	Indicates if the client is connected to the primary server within the collective.
	IsDeleted	This read-only property indicates whether the object has been deleted. (Inherited from AFObject.)
	LastCommunicationTime	The last communication time to the primary server within the collective.
	LastSyncTime	The last synchronization time to the primary server within the collective.
	Name	Read/write property that identifies the name of the object.
	PISystem	This read-only property allows access to the PISystem associated with this object. (Inherited from AFObject.)
	Port	Read/write property that is the port number used to connect to the PI AF Server for this AFCollectiveMember on the remote host.
	Priority	Indicates the priority order in which to select a collective member.
	Protocol	Read/write property that is the protocol used to connect to the PI AF Server for this AFCollectiveMember on the remote host.
	ServerRole	The role of the collective member server within the AFCollective.
	ServerVersion	Read-only property that contains a string that uniquely identifies the current server version.
	StreamedPort	Read-only property that is the port number used to connect to the streamed interface of the PI AF Server for this AFCollectiveMember on the remote host.
	SyncStatus	The status of the synchronization between the members of the collective.
	TimeOut	Read/write property that is the connection timeout used to connect to the PI AF Server for this AFCollectiveMember on the remote host.
	UniqueID	Read-only property that provides the object's ID as a String. (Inherited from AFObject.)

AF SDK Reference

AFCollectiveMember Properties

Table of Contents

AFCollectiveMember Properties

Properties

See Also

Reference

In This Topic

Related Links