Skip to content

IAdmServiceSessions

The IAdmServiceSessions interface represents a collection of Adaxes service client sessions.

Inheritance: The IAdmServiceSessions interface inherits from the IEnumerable interface.

Methods

  • Method

  • Description

  • GetEnumerator()

  • Returns an enumerator object for this collection of Adaxes service client sessions.

  • GetItem()

  • Returns an Adaxes service client session by its index.

  • Disconnect()

  • Disconnects the specified Adaxes service client session.

  • Ban()

  • Bans all Adaxes service client sessions created by a certain host for the specified period of time.

Properties

  • Property

  • Description

  • Count

  • Gets the number of client sessions in the collection.

  • AsOfDate

  • Gets the UTC date and time when the collection was generated.

Details

GetEnumerator()

Returns an enumerator object for this collection of Adaxes service client sessions. The enumerator object implements the IEnumerator interface that can be used to enumerate client sessions in foreach loops.

IEnumerator GetEnumerator()

GetItem()

Returns an Adaxes service client session by its index.

IAdmServiceSession GetItem(Int32 index)

Parameters

The index parameter contains the index of the client session to return.


Disconnect()

Disconnects the specified Adaxes service client session.

void Disconnect(Object session)

Parameters

The session parameter specifies either the identifier (Integer or String) of the client session or the IAdmServiceSession interface that represents the session.


Ban()

Bans all Adaxes service client sessions created by a certain host for the specified period of time.

void Ban(String dnsHostName, Int32 banDurationSeconds)

Parameters

  • dnsHostName - Specifies the DNS name of the host to ban.
  • banDurationSeconds - Specifies the ban duration in seconds.

Count

Gets the number of client sessions in the collection.

  • Type:
  • Int32
  • Access:
  • Read-only

AsOfDate

Gets the UTC date and time when the collection was generated.

  • Type:
  • DateTime
  • Access:
  • Read-only

Requirements

Minimum required version: 2009.1

See also