The XmppClient type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | XmppClient(String, Int32, Boolean, RemoteCertificateValidationCallback) |
Initializes a new instance of the XmppClient class.
|
| XmppClient(String, String, String, Int32, Boolean, RemoteCertificateValidationCallback) |
Initializes a new instance of the XmppClient class.
|
Methods
| Name | Description | |
|---|---|---|
| AddContact |
Adds the contact with the specified JID to the user's roster.
|
| Authenticate |
Authenticates with the XMPP server using the specified username and
password.
|
| Block |
Blocks all communication to and from the XMPP entity with the specified JID.
|
| Buzz |
Buzzes the user with the specified JID in order to get his or her attention.
|
| CancelFileTransfer |
Cancels the specified file-transfer.
|
| Close |
Closes the connection with the XMPP server. This automatically disposes
of the object.
|
| Connect |
Establishes a connection to the XMPP server.
|
| Dispose()()()() |
Releases all resources used by the current instance of the XmppClient class.
|
 | Dispose(Boolean) |
Releases all resources used by the current instance of the XmppClient
class, optionally disposing of managed resource.
|
| Equals | (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetBlocklist |
Returns an enumerable collection of blocked contacts.
|
| GetFeatures |
Returns an enumerable collection of XMPP features supported by the XMPP
client with the specified JID.
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetRoster |
Retrieves the user's roster (contact list).
|
| GetTime |
Retrieves the current time of the XMPP client with the specified JID.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetVersion |
Retrieves the software version of the XMPP client with the specified JID.
|
| InitiateFileTransfer(Jid, String, String, Action<(Of <<'(Boolean, FileTransfer>)>>)) |
Offers the specified file to the XMPP user with the specified JID and, if
accepted by the user, transfers the file.
|
| InitiateFileTransfer(Jid, Stream, String, Int64, String, Action<(Of <<'(Boolean, FileTransfer>)>>)) |
Offers the XMPP user with the specified JID the file with the specified
name and, if accepted by the user, transfers the file using the supplied
stream.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Ping |
Pings the user with the specified JID.
|
| Register |
Initiates in-band registration with the XMPP server in order to register
a new XMPP account.
|
| RemoveContact(Jid) |
Removes the item with the specified JID from the user's roster.
|
| RemoveContact(RosterItem) |
Removes the specified item from the user's roster.
|
| SendMessage(Message) |
Sends the specified chat message.
|
| SendMessage(Jid, IDictionary<(Of <<'(String, String>)>>), IDictionary<(Of <<'(String, String>)>>), String, MessageType, CultureInfo) |
Sends a chat message with the specified content to the specified JID.
|
| SendMessage(Jid, String, String, String, MessageType, CultureInfo) |
Sends a chat message with the specified content to the specified JID.
|
| SetActivity |
Sets the user's activity to the specified activity value(s).
|
| SetAvatar |
Publishes the image located at the specified path as the user's avatar.
|
| SetMood |
Sets the user's mood to the specified mood value.
|
| SetStatus(Status) |
Sets the availability status.
|
| SetStatus(Availability, Dictionary<(Of <<'(String, String>)>>), SByte) |
Sets the availability status.
|
| SetStatus(Availability, String, SByte, CultureInfo) |
Sets the availability status.
|
| SetTune(TuneInformation) |
Publishes the specified music information to contacts on the user's
roster.
|
| SetTune(String, String, String, Int32, Int32, String, String) |
Publishes the specified music information to contacts on the user's
roster.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Unblock |
Unblocks all communication to and from the XMPP entity with the specified
JID.
|
Properties
| Name | Description | |
|---|---|---|
 | Authenticated |
Determines whether the instance has been authenticated.
|
| Connected |
Determines whether the instance is connected to the XMPP server.
|
| FileTransferRequest |
A callback method to invoke when a request for a file-transfer is received
from another XMPP user.
|
| FileTransferSettings |
Contains settings for configuring file-transfer options.
|
| Hostname |
The hostname of the XMPP server to connect to.
|
| Im |
The underlying XmppIm instance.
|
| IsEncrypted |
Determines whether the session with the server is TLS/SSL encrypted.
|
| Jid |
The address of the Xmpp entity.
|
| Password |
The password with which to authenticate.
|
| Port |
The port number of the XMPP service of the server.
|
| SubscriptionRequest |
A callback method to invoke when a request for a subscription is received
from another XMPP user.
|
| Tls |
If true the session will be TLS/SSL-encrypted if the server supports it.
|
| Username |
The username with which to authenticate. In XMPP jargon this is known
as the 'node' part of the JID.
|
| Validate |
A delegate used for verifying the remote Secure Sockets Layer (SSL)
certificate which is used for authentication.
|
Events
| Name | Description | |
|---|---|---|
 | ActivityChanged |
The event that is raised when an activity notification has been received.
|
| AvatarChanged |
The event that is raised when a contact has updated his or her avatar.
|
| ChatStateChanged |
The event that is raised when the chat-state of an XMPP entity has
changed.
|
| Error |
The event that is raised when an unrecoverable error condition occurs.
|
| FileTransferAborted |
The event that is raised when an on-going file-transfer has been aborted
prematurely, either due to cancellation or error.
|
| FileTransferProgress |
The event that is raised periodically for every file-transfer operation to
inform subscribers of the progress of the operation.
|
| Message |
The event that is raised when a chat message is received.
|
| MoodChanged |
The event that is raised when a mood notification has been received.
|
| RosterUpdated |
The event that is raised when the roster of the user has been updated,
i.e. a contact has been added, removed or updated.
|
| StatusChanged |
The event that is raised when a status notification has been received.
|
| SubscriptionApproved |
The event that is raised when a subscription request made by the JID
associated with this instance has been approved.
|
| SubscriptionRefused |
The event that is raised when a subscription request made by the JID
associated with this instance has been refused.
|
| Tune |
The event that is raised when a contact has published tune information.
|
| Unsubscribed |
The event that is raised when a user or resource has unsubscribed from
receiving presence notifications of the JID associated with this instance.
|
