Jitsi: the OpenSource Java VoIP and Instant Messaging client.

Package net.java.sip.communicator.service.protocol

Interface Summary
AdHocChatRoom Represents an ad-hoc rendez-vous point where multiple chat users could communicate together.
AdHocChatRoomInvitation This interface represents an invitation, which is send from an ad-hoc chat room participant to another user in order to invite this user to join the ad-hoc chat room.
AuthorizationHandler Instances of this interface are used by the protocol provider in order to make the user act upon requests coming from contacts that would like to add us to their contact list or simply track oour presence status, or whenever a subscription request has failed for a particular contact because we need to first generate an authorization request demanding permission to subscibe.
CallPeer The CallPeer is an interface that represents peers in a call.
ChatRoom Represents a chat channel/room/rendez-vous point/ where multiple chat users could rally and communicate in a many-to-many fashion.
ChatRoomConfigurationForm The ChatRoomConfigurationForm contains the chat room configuration.
ChatRoomConfigurationFormField The ChatRoomConfigurationFormField is contained in the ChatRoomConfigurationForm and represents a configuration property of a chat room.
ChatRoomInvitation This interface represents an invitation, which is send from a chat room member to another user in order to invite this user to join the chat room.
ChatRoomMember This interface represents chat room participants.
ConferenceMember Represents a member and its details in a telephony conference managed by a CallPeer in its role as a conference focus.
Contact This class represents the notion of a Contact or Buddy, that is widely used in instant messaging today.
ContactGroup A ContactGroup is a collection of Contacts/Buddies/Subscriptions, stored by a communications service (e.g.
FileTransfer The FileTransfer interface is meant to be used by parties interested in the file transfer process.
IncomingFileTransferRequest Used for incoming file transfer request.
Message Used to access the content of instant messages that are sent or received via the instant messaging operation set.
OperationSet  
OperationSetAdHocMultiUserChat Allows creating, configuring, joining and administering of individual text-based ad-hoc conference rooms.
OperationSetAdvancedAutoAnswer An Advanced Operation Set defining options to auto answer/forward incoming calls.
OperationSetAdvancedTelephony<T extends ProtocolProviderService> Extends OperationSetBasicTelephony with advanced telephony operations such as call transfer.
OperationSetAvatar This interface is an extension of the operation set, meant to be implemented by protocols that support user avatar.
OperationSetBasicAutoAnswer An Operation Set defining option to unconditional auto answer incoming calls.
OperationSetBasicInstantMessaging Provides basic functionality for sending and receiving InstantMessages.
OperationSetBasicTelephony<T extends ProtocolProviderService> An Operation Set defining all basic telephony operations such as conducting simple calls and etc.
OperationSetCallTransfer An OperationSet defining operations that allow transferring calls to a new location.
OperationSetChangePassword An operation set that allows "inband" change of the account password
OperationSetContactCapabilities Represents an OperationSet to query the OperationSets supported for a specific Contact.
OperationSetContactTypeInfo Operation set used for type of contacts, retrieving changing and creating contacts with types.
OperationSetDesktopSharingClient Represents an OperationSet giving access to desktop sharing client-side specific functionalities.
OperationSetDesktopSharingServer Represents an OperationSet giving access to desktop sharing server-side specific functionalities.
OperationSetDesktopStreaming Represents an OperationSet giving access to desktop streaming specific functionality.
OperationSetDTMF An OperationSet that allows other modules to send DMF tones through this protocol provider.
OperationSetExtendedAuthorizations Contains methods that would allow service users to re-request authorizations to add a contact to their contact list or, send them an authorization before having been asked.
OperationSetFileTransfer The File Transfer Operation Set provides an interface towards those functions of a given protocol, that allow transferring files among users.
OperationSetGenericNotifications Provides notification for custom/generic events and possibility to generate such events.
OperationSetGeolocation This interface is an extension of the operation set, meant to be implemented by protocols that support exchange of geolocation details (like Jabber for example).
OperationSetIncomingDTMF An OperationSet that allows us to receive DTMF tones through this protocol provider.
OperationSetInstantMessageFiltering An operation set that allows plugins to register filters which could intercept instant messages and determine whether or not they should be dispatched to regular listeners.
OperationSetInstantMessageTransform The Instant Message Transform operation set allows, when \ supported to insert message transform layers that could change incoming messages before they are delivered to the user and outgoing ones before they reach the protocol stack and get sent.
OperationSetMessageCorrection Provides functionality for correcting instant messages.
OperationSetMessageWaiting Provides notifications for message waiting notifications.
OperationSetMultiUserChat Allows creating, configuring, joining and administering of individual text-based conference rooms.
OperationSetPersistentPresence This interface is an extension of the presence operation set, meant to be implemented by protocols that support server stored contact lists (like icq for example).
OperationSetPresence OperationSetPresence offers methods that allow managing the presence status of the provider, and subscribing to that of our buddies (i.e.
OperationSetSecureSDesTelephony Marker interface to indicate that a protocol supports SDES encryption.
OperationSetSecureTelephony An Operation Set defining the encryption operations for telephony.
OperationSetSecureZrtpTelephony Marker interface to indicate that a protocol supports ZRTP encryption.
OperationSetServerStoredAccountInfo The Account Info Operation set is a means of accessing and modifying detailed information on the user/account that is currently logged in through this provider.
OperationSetServerStoredContactInfo The User Info Operation set is a means of accessing detailed information of Contacts that have made it available on-line (on a protocol server, p2p net or others).
OperationSetServerStoredContactInfo.DetailsResponseListener Retrieving details can take some time, this listener will inform when retrieving has ended and will return the details if any.
OperationSetSmsMessaging Provides basic functionality for sending and receiving SMS Messages.
OperationSetTelephonyConferencing Provides operations necessary to create and handle conferencing calls.
OperationSetThumbnailedFileFactory The OperationSetThumbnailedFileFactory is meant to be used by bundles interested in making files with thumbnails.
OperationSetTypingNotifications The operation set allows user bundles (e.g.
OperationSetVideoTelephony Represents an OperationSet giving access to video-specific functionality in telephony such as visual Components displaying video and listening to dynamic availability of such Components.
OperationSetWebAccountRegistration The operation set is there to propose an extremely simple and light way of registering new accounts for a given protocol.
OperationSetWebContactInfo The operation set is a very simplified version of the server stored info operation sets, allowing protocol providers to implement a quick way of showing user information, by simply returning a URL where the information of a specific user is to be found.
OperationSetWhiteboarding Provides basic functionality for white-board.
ProtocolIcon The ProtocolIcon interface is meant to be implemented by protocol implementations in order to export their icon.
ProtocolNames Specifies the names of some of the most popular instant messageing protocols.
ProtocolProviderService The ProtocolProvider interface should be implemented by bundles that wrap Instant Messaging and telephony protocol stacks.
SecurityAuthority Implemented by the user interface, this interface allows a protocol provider to asynchronously demand passwords necessary for authentication against various realms.
TransferAuthority Interacts with user for received transfer request for unknown calls.
TransformLayer An instance of the TransformLayer, when registered with OperationSetInstantMessageTransform would be passed all message events.
WhiteboardInvitation This interface represents an invitation, which is send from a whiteboard participant to another user in order to invite this user to join the whiteboard.
WhiteboardParticipant The WhiteboardParticipant is an interface that represents participants in a whiteboard.
WhiteboardSession A represenation of a WhiteboardSession.
 

Class Summary
AbstractCall<T extends CallPeer,U extends ProtocolProviderService> Provides implementations for some of the methods in the Call abstract class to facilitate implementations.
AbstractCallPeer<T extends Call,U extends ProtocolProviderService> Provides a default implementation for most of the CallPeer methods with the purpose of only leaving custom protocol development to clients using the PhoneUI service.
AbstractConferenceMember Provides the default implementation of the ConferenceMember interface.
AbstractFileTransfer An abstract implementation of the FileTransfer interface providing implementation of status and progress events related methods and leaving all protocol specific methods abstract.
AbstractMessage Represents a default implementation of Message in order to make it easier for implementers to provide complete solutions while focusing on implementation-specific details.
AbstractOperationSetAvatar<T extends ProtocolProviderService> Represents a default implementation of OperationSetAvatar in order to make it easier for implementers to provide complete solutions while focusing on implementation-specific details.
AbstractOperationSetBasicAutoAnswer An Abstract Operation Set defining option to unconditionally auto answer incoming calls.
AbstractOperationSetBasicInstantMessaging Represents a default implementation of OperationSetBasicInstantMessaging in order to make it easier for implementers to provide complete solutions while focusing on implementation-specific details.
AbstractOperationSetContactCapabilities<T extends ProtocolProviderService> Represents a default implementation of OperationSetContactCapabilities which attempts to make it easier for implementers to provide complete solutions while focusing on implementation-specific functionality.
AbstractOperationSetDesktopSharingClient<T extends ProtocolProviderService> Represents a default/base implementation of OperationSetDesktopSharingClient which attempts to make it easier for implementers to provide complete solutions while focusing on implementation-specific functionality.
AbstractOperationSetMultiUserChat Represents a default implementation of OperationSetMultiUserChat in order to make it easier for implementers to provide complete solutions while focusing on implementation-specific details.
AbstractOperationSetPersistentPresence<T extends ProtocolProviderService> Represents a default implementation of OperationSetPersistentPresence in order to make it easier for implementers to provide complete solutions while focusing on implementation-specific details.
AbstractOperationSetServerStoredAccountInfo Represents a default implementation of OperationSetServerStoredAccountInfo in order to make it easier for implementers to provide complete solutions while focusing on implementation-specific details.
AbstractOperationSetTypingNotifications<T extends ProtocolProviderService> Represents a default implementation of OperationSetTypingNotifications in order to make it easier for implementers to provide complete solutions while focusing on implementation-specific details.
AbstractProtocolProviderService Implements standard functionality of ProtocolProviderService in order to make it easier for implementers to provide complete solutions while focusing on protocol-specific details.
AccountID The AccountID is an account identifier that, uniquely represents a specific user account over a specific protocol.
AccountInfoUtils Utility class that would give to interested parties an easy access to some of most popular account details, like : first name, last name, birth date, image, etc.
AccountManager Represents an implementation of AccountManager which loads the accounts in a separate thread.
AccountManagerUtils Provides utilities to aid the manipulation of AccountManager.
ActiveCallsRepository<T extends Call,U extends OperationSetBasicTelephony<? extends ProtocolProviderService>> Keeps a list of all calls currently active and maintained by this protocol provider.
AuthorizationRequest This class is used to represent both incoming and outgoing AuthorizationRequests-s
AuthorizationResponse This class is used to represent both incoming and outgoing AuthorizationResponse-s
AuthorizationResponse.AuthorizationResponseCode Authorization response codes represent unambiguous indication of the way a user or a remote party have acted upon an authorization request.
Call A representation of a call.
CallConference Represents the telephony conference-related state of a Call.
CallPeerState The CallPeerState class reflects the current state of a call peer.
CallState The CallState class reflects the current state of a call.
JingleNodeDescriptor A JingleNodesDescriptor stores information necessary to create a JingleNodes tracker or relay candidate harvester that we could use with ICE4J.
NotificationMessage A notification message that is used to deliver notifications for an waiting server message.
OperationSetInstantMessageTransformImpl  
PhoneNumberI18nService Implements PhoneNumberI18nService which aids the parsing, formatting and validating of international phone numbers.
PresenceStatus The class is used to represent the state of the connection of a given ProtocolProvider or Contact.
ProtocolProviderActivator Implements BundleActivator for the purposes of protocol.jar/protocol.provider.manifest.mf and in order to register and start services independent of the specifics of a particular protocol.
ProtocolProviderFactory The ProtocolProviderFactory is what actually creates instances of a ProtocolProviderService implementation.
ProxyInfo The supported proxy types and properties used to store the values in the configuration service.
RegistrationState The class represents a set of states that a protocol provider may take while registering, logging in, or signing on to a public service server, such as a SIP registrar, the ICQ/AIM login and registration servers or a Jabber server.
ServerStoredDetails The ServerStoredDetails class contains a relatively large set of details that various protocols may support storing online.
ServerStoredDetails.AddressDetail A detail representing an address (street and street/house number).
ServerStoredDetails.BinaryDetail A generic detail used for representing binary content such as photos logos, avatars ....
ServerStoredDetails.BirthDateDetail A complete birth date.
ServerStoredDetails.BooleanDetail A generic detail that should be used (extended) when representing any boolean values.
ServerStoredDetails.CalendarDetail A generic detail meant to represent any date (calendar) associated details.
ServerStoredDetails.CityDetail A City name associated with a (home) address.
ServerStoredDetails.CountryDetail A detail representing a country of residence for the corresponding subject.
ServerStoredDetails.DisplayNameDetail The name that should be displayed to identify the information author.
ServerStoredDetails.EmailAddressDetail Represents a (personal) email address.
ServerStoredDetails.FaxDetail A Fax number.
ServerStoredDetails.FirstNameDetail A first, given name.
ServerStoredDetails.GenderDetail A bi-state detail indicating a gender.
ServerStoredDetails.GenericDetail A generic detail used as the root of all other server stored details.
ServerStoredDetails.ImageDetail A detail containing any contact related images.
ServerStoredDetails.InterestDetail Represents a personal interest or hobby.
ServerStoredDetails.LastNameDetail A last (family) name.
ServerStoredDetails.LocaleDetail A generic detail that should be used (extended) when representing details that have anything to do with locales (countries, languages, etc).
ServerStoredDetails.MiddleNameDetail A Middle (father's) name.
ServerStoredDetails.MobilePhoneDetail A detail used for representing a (personal) mobile phone number.
ServerStoredDetails.NameDetail A generic detail representing any kind of name.
ServerStoredDetails.NicknameDetail An informal name (nickname) used for referring to the subject.
ServerStoredDetails.NumberDetail A generic detail that should be used (extended) when representing any numbers.
ServerStoredDetails.PagerDetail A Pager number.
ServerStoredDetails.PhoneNumberDetail A generic detail used for representing a (personal) phone number.
ServerStoredDetails.PostalCodeDetail A postal or ZIP code associated with a (home) address.
ServerStoredDetails.ProvinceDetail The name of a state/province/region associated with a (home) address.
ServerStoredDetails.SpokenLanguageDetail A locale detail indicating a language spoken by the corresponding Contact.
ServerStoredDetails.StringDetail A generic detail that should be used (extended) when representing details with a String content.
ServerStoredDetails.TimeZoneDetail A generic detail meant to represent the time zone associated with the corresponding contact and that could be extended to represent other time zone related details.
ServerStoredDetails.URLDetail A generic detail representing any url
ServerStoredDetails.WebPageDetail A personal web page.
ServerStoredDetails.WorkAddressDetail A detail representing a street name and number associated with a work address.
ServerStoredDetails.WorkCityDetail A City name associated with a work address.
ServerStoredDetails.WorkCountryDetail The name of a country associated with a work address.
ServerStoredDetails.WorkEmailAddressDetail Represents a (personal) email address.
ServerStoredDetails.WorkMobilePhoneDetail A detail used for representing a work mobile phone number.
ServerStoredDetails.WorkOrganizationNameDetail The name of the organization (company, ngo, university, hospital or other) employing the corresponding contact.
ServerStoredDetails.WorkPageDetail A web page associated with the subject's principal occupation (work).
ServerStoredDetails.WorkPhoneDetail A detail used for representing a work phone number.
ServerStoredDetails.WorkPostalCodeDetail A postal or ZIP code associated with a work address.
ServerStoredDetails.WorkProvinceDetail The name of a state/province/region associated with a work address.
SingleCallInProgressPolicy Imposes the policy to have one call in progress i.e.
StunServerDescriptor A StunServerDescriptor stores information necessary to create a STUN or TURN candidate harvester that we could use with ICE4J.
UserCredentials The class is used whenever user credentials for a particular realm (site server or service) are necessary
WhiteboardParticipantState The WhiteboardParticipantState class reflects the current state of a whiteboard participant.
WhiteboardPoint A point representing a location in (x,y) coordinate space, specified in integer precision.
WhiteboardSessionState The WhiteboardSessionState class reflects the current state of a whiteboard session.
 

Enum Summary
AbstractOperationSetBasicInstantMessaging.MessageEventType  
ChatRoomMemberRole Indicates roles that a chat room member detains in its containing chat room.
ConferenceMemberState Represents the state of the device and signaling session of ConferenceMember in the conference it is participating in.
OperationSetExtendedAuthorizations.SubscriptionStatus The available subscription of the contact.
OperationSetMessageWaiting.MessageType Message waiting types.
ProxyInfo.ProxyType Enum which stores possible proxy types
TransportProtocol Enumerates the "transport" (OSI transport/application) protocols used to carry the control channel for protocol services like xmmp, sip, etc.
 

Exception Summary
OperationFailedException OperationFailedException indicates an exception that occurred in the API.
OperationNotSupportedException The OperationNotSupportedException is used by telephony providers as an indication that a requested operation is not supported or implemented.
 


Jitsi: the OpenSource Java VoIP and Instant Messaging client.

Jitsi, the OpenSource Java VoIP and Instant Messaging client.
Distributable under LGPL license.