Simias::Web::DomainInformation Class Reference

Domain information. More...

Collaboration diagram for Simias::Web::DomainInformation:

[legend]

List of all members.

Public Member Functions
	DomainInformation ()
	Constructor.
	DomainInformation (string domainID)
	Constructs a DomainInformation object.
override string	ToString ()
	Create a string representation.
Public Attributes
DomainType	Type
	Domain Type.
bool	Active
	Domain Active true - a state where collections belonging to the domain can synchronize, remote invitations can occur etc. false - no remote actions will take place.
bool	Authenticated
	Indicates if the domain is authenticated or not.
string	Name
	Domain Name.
string	Description
	Domain Description.
string	ID
	Domain ID.
string	MemberUserID
	The unique member/user ID.
string	MemberName
	The name of the member object.
string	RemoteUrl
	Url to the remote domain service.
string	POBoxID
	POBox ID.
string	HostUrl
	The Simias URL for this domain.
string	Host
	The host for this domain.
bool	IsSlave
	True if the local domain is a slave (client).
bool	IsDefault
	True if the local domain is the default domain.
Simias.Authentication.StatusCodes	StatusCode
	The status of the authentication request.
int	RemainingGraceLogins
	The grace logins remaining. Valid if StatusCode == StatusCode.SuccessInGrace.

---

Detailed Description

Domain information.

---

Constructor & Destructor Documentation

Simias::Web::DomainInformation::DomainInformation

(

)

[inline]

Constructor.

Simias::Web::DomainInformation::DomainInformation

(

string

domainID

)

[inline]

Constructs a DomainInformation object.

Parameters:

domainID

The ID of the domain to base this object on.

---

Member Function Documentation

override string Simias::Web::DomainInformation::ToString

(

)

[inline]

Create a string representation.

Returns:

A string representation

---

Member Data Documentation

DomainType Simias::Web::DomainInformation::Type

Domain Type.

bool Simias::Web::DomainInformation::Active

Domain Active true - a state where collections belonging to the domain can synchronize, remote invitations can occur etc. false - no remote actions will take place.

bool Simias::Web::DomainInformation::Authenticated

Indicates if the domain is authenticated or not.

string Simias::Web::DomainInformation::Name

Domain Name.

string Simias::Web::DomainInformation::Description

Domain Description.

string Simias::Web::DomainInformation::ID

Domain ID.

string Simias::Web::DomainInformation::MemberUserID

The unique member/user ID.

string Simias::Web::DomainInformation::MemberName

The name of the member object.

string Simias::Web::DomainInformation::RemoteUrl

Url to the remote domain service.

string Simias::Web::DomainInformation::POBoxID

POBox ID.

string Simias::Web::DomainInformation::HostUrl

The Simias URL for this domain.

string Simias::Web::DomainInformation::Host

The host for this domain.

bool Simias::Web::DomainInformation::IsSlave

True if the local domain is a slave (client).

bool Simias::Web::DomainInformation::IsDefault

True if the local domain is the default domain.

Simias.Authentication.StatusCodes Simias::Web::DomainInformation::StatusCode

The status of the authentication request.

int Simias::Web::DomainInformation::RemainingGraceLogins

The grace logins remaining. Valid if StatusCode == StatusCode.SuccessInGrace.

---

The documentation for this class was generated from the following file:

• src/core/WebService/Simias.asmx.cs