[go: up one dir, main page]

Menu

[r52]: / Api / Act.TypeLib.XML  Maximize  Restore  History

Download this file

486 lines (485 with data), 20.0 kB

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Act.TypeLib</name>
    </assembly>
    <members>
        <member name="T:Act.TypeLib.Networks.Statuses.Status">
            <summary>
            Act basic status
            </summary>
        </member>
        <member name="F:Act.TypeLib.Networks.Statuses.Status._description">
            <summary>
            Status description
            </summary>
        </member>
        <member name="P:Act.TypeLib.Networks.Statuses.Status.Name">
            <summary>
            Status full name
            </summary>
        </member>
        <member name="P:Act.TypeLib.Networks.Statuses.Status.Description">
            <summary>
            Status description
            </summary>
        </member>
        <member name="P:Act.TypeLib.Networks.Statuses.Status.NetworkName">
            <summary>
            Status network name
            </summary>
        </member>
        <member name="T:Act.TypeLib.Networks.InstantMessages.InstantMessage">
            <summary>
            Act instant message
            </summary>
        </member>
        <member name="F:Act.TypeLib.Networks.InstantMessages.InstantMessage._messageText">
            <summary>
            Message text
            </summary>
        </member>
        <member name="F:Act.TypeLib.Networks.InstantMessages.InstantMessage._messageHtml">
            <summary>
            Message html
            </summary>
        </member>
        <member name="F:Act.TypeLib.Networks.InstantMessages.InstantMessage._contact">
            <summary>
            Contact from this message was sended or where to send
            </summary>
        </member>
        <member name="M:Act.TypeLib.Networks.InstantMessages.InstantMessage.#ctor(Act.TypeLib.Roster.Contact)">
            <summary>
            Constructor
            </summary>
            <param name="contact">Roster item</param>
        </member>
        <member name="M:Act.TypeLib.Networks.InstantMessages.InstantMessage.#ctor(Act.TypeLib.Roster.Contact,System.String)">
            <summary>
            Constructor
            </summary>
            <param name="contact">Roster item</param>
            <param name="messageText">Message text</param>
        </member>
        <member name="M:Act.TypeLib.Networks.InstantMessages.InstantMessage.#ctor(Act.TypeLib.Roster.Contact,System.String,System.String)">
            <summary>
            Constructor
            </summary>
            <param name="contact">Roster item</param>
            <param name="messageText">Message text</param>
            <param name="messageHtml">Message html</param>
        </member>
        <member name="P:Act.TypeLib.Networks.InstantMessages.InstantMessage.Contact">
            <summary>
            Roster item
            </summary>
        </member>
        <member name="P:Act.TypeLib.Networks.InstantMessages.InstantMessage.Text">
            <summary>
            Message text
            </summary>
        </member>
        <member name="P:Act.TypeLib.Networks.InstantMessages.InstantMessage.Html">
            <summary>
            Message html
            </summary>
        </member>
        <member name="T:Act.TypeLib.Plugins.MessageInfo">
            <summary>
            Used as message description when sending and receiving message
            </summary>
        </member>
        <member name="F:Act.TypeLib.Plugins.MessageInfo._messageName">
            <summary>
            Name of message witch plugin is sending
            </summary>
        </member>
        <member name="F:Act.TypeLib.Plugins.MessageInfo._messageSender">
            <summary>
            Name of plugin sending message
            </summary>
        </member>
        <member name="M:Act.TypeLib.Plugins.MessageInfo.#ctor(System.String)">
            <summary>
            Constructor
            </summary>
            <param name="messageName">Message name witch have to be sended</param>
        </member>
        <member name="M:Act.TypeLib.Plugins.MessageInfo.#ctor(System.String,System.String)">
            <summary>
            Constructor
            </summary>
            <param name="messageName">Message name witch have to be sended</param>
            <param name="senderName">Sending component name</param>
        </member>
        <member name="P:Act.TypeLib.Plugins.MessageInfo.MessageName">
            <summary>
            Name of message witch plugin is sending
            </summary>
        </member>
        <member name="P:Act.TypeLib.Plugins.MessageInfo.MessageSender">
            <summary>
            Name of plugin sending message
            </summary>
        </member>
        <member name="T:Act.TypeLib.Networks.Statuses.OfflineStatus">
            <summary>
            Act offline status
            </summary>
        </member>
        <member name="T:Act.TypeLib.Networks.Statuses.AwayStatus">
            <summary>
            Act away status
            </summary>
        </member>
        <member name="T:Act.TypeLib.Plugins.PluginInfoAttribute">
            <summary>
            Allows plugin manager to show basic information about plugin
            </summary>
        </member>
        <member name="F:Act.TypeLib.Plugins.PluginInfoAttribute._name">
            <summary>
            Plugin name
            </summary>
        </member>
        <member name="F:Act.TypeLib.Plugins.PluginInfoAttribute._description">
            <summary>
            Plugin description
            </summary>
        </member>
        <member name="M:Act.TypeLib.Plugins.PluginInfoAttribute.#ctor(System.String,System.String)">
            <summary>
            Constructor
            </summary>
            <param name="name">Plugin name</param>
            <param name="description">Plugin descrtiption</param>
        </member>
        <member name="P:Act.TypeLib.Plugins.PluginInfoAttribute.Name">
            <summary>
            Plugin name
            </summary>
        </member>
        <member name="P:Act.TypeLib.Plugins.PluginInfoAttribute.Description">
            <summary>
            Plugin description
            </summary>
        </member>
        <member name="T:Act.TypeLib.Plugins.Plugin">
            <summary>
            Act plugin base class
            </summary>
            <summary>
            Act plugin base class
            </summary>
        </member>
        <member name="F:Act.TypeLib.Plugins.Plugin._dependencies">
            <summary>
            Holds messages on witch plugin depends
            </summary>
        </member>
        <member name="M:Act.TypeLib.Plugins.Plugin.GetMessages">
            <summary>
            Returns list of messages that should be automaticly loaded
            </summary>
            <returns>List of messages with their names</returns>
        </member>
        <member name="M:Act.TypeLib.Plugins.Plugin.MessageUnregistered(System.String)">
            <summary>
            Handles message unregistered event
            </summary>
            <remarks>
               Calls messageName+"_unregistered" method if message is on dependency list
            </remarks>
            <param name="messageName">Message name</param>
        </member>
        <member name="M:Act.TypeLib.Plugins.Plugin.CheckDependencies">
            <summary>
            Checks plugin dependency list
            </summary>
            <remarks>
            If one of messages is not available calls messageName+"_notregistered" method.
            If messageName+"_notregistered" not exists or returns true execution is continued else method returns false
            </remarks>
            <returns>True if Act plugin configuration meets requirements</returns>
        </member>
        <member name="M:Act.TypeLib.Plugins.Plugin.UnregisterPlugin">
            <summary>
            Unregisters all plugins messages
            </summary>
            <returns>True if operation was successful</returns>
        </member>
        <member name="M:Act.TypeLib.Plugins.Plugin.DependencyCheck(Act.TypeLib.Plugins.MessageInfo,System.Collections.Generic.List{System.Object},System.Object[])">
            <summary>
            Message checking if all dependencies are satisfied
            </summary>
            <param name="messageInfo">Message description object</param>
            <param name="results">Stores results of invokation for multi event handling or null if not important</param>
            <param name="parameters">Parameters for method invoked by delegate</param>
            <returns>Result of invokation as List of objects - one object for invoked method</returns>
        </member>
        <member name="P:Act.TypeLib.Plugins.Plugin.RegisterMessage">
            <summary>
            Method invoked in case of registering message
            </summary>
        </member>
        <member name="P:Act.TypeLib.Plugins.Plugin.UnregisterMessage">
            <summary>
            Method invoked in case of unregistering message
            </summary>
        </member>
        <member name="P:Act.TypeLib.Plugins.Plugin.IsMessageRegistered">
            <summary>
            Method invoked when plugin wants to know if message is registered
            </summary>
        </member>
        <member name="P:Act.TypeLib.Plugins.Plugin.SendMessage">
            <summary>
            Method invoked in case of sending message
            </summary>
        </member>
        <member name="T:Act.TypeLib.Plugins.Plugin.DSendMessage">
            <summary>
            Delegate type for method that sends messages
            </summary>
            <param name="message">Message description object</param>
            <param name="results">Stores results of invokation for multi event handling or null if not important</param>
            <param name="parameters">Parameters for method invoked by delegate</param>
            <returns>Result of invokation as List of objects - one object for invoked method</returns>
            <remarks>Object returned is in most cases provided by invoking methods or in case of exception PluginManager will return false</remarks>
        </member>
        <member name="T:Act.TypeLib.Plugins.Plugin.DRegisterMessage">
            <summary>
            Delegate type of method for registering message
            </summary>
            <param name="methodInfo">Message method MethodInfo object</param>
            <param name="message">SendMessage delegate object</param>
            <returns>Information about success of registering</returns>
            <remarks>Method that must be registered have to have MessageAttribute attribute</remarks>
        </member>
        <member name="T:Act.TypeLib.Plugins.Plugin.DUnregisterMessage">
            <summary>
            Delegate type of method for unregistering message
            </summary>
            <param name="methodInfo">Message method MethodInfo object</param>
            <param name="message">SendMessage delegate object</param>
            <returns>Information about success of unregistering</returns>
        </member>
        <member name="T:Act.TypeLib.Plugins.Plugin.DIsMessageRegistered">
            <summary>
            Delegate type of method for checking if message is registered
            </summary>
            <param name="messageName">Message name</param>
            <returns>Information about registration of given message</returns>
        </member>
        <member name="T:Act.TypeLib.Plugins.MessageAttribute">
            <summary>
            Allows Plugin manager to register method as message
            </summary>
        </member>
        <member name="F:Act.TypeLib.Plugins.MessageAttribute._messageName">
            <summary>
            Message name
            </summary>
        </member>
        <member name="F:Act.TypeLib.Plugins.MessageAttribute._autoLoad">
            <summary>
            True if PluginManager should register message automaticly
            </summary>
        </member>
        <member name="M:Act.TypeLib.Plugins.MessageAttribute.#ctor(System.String,System.Boolean)">
            <summary>
            Contructor
            </summary>
            <param name="messageName">Message name</param>
            <param name="autoLoad">Auto register option</param>
        </member>
        <member name="M:Act.TypeLib.Plugins.MessageAttribute.#ctor(System.String)">
            <summary>
            Contructor
            </summary>
            <param name="messageName">Message name</param>
        </member>
        <member name="P:Act.TypeLib.Plugins.MessageAttribute.MessageName">
            <summary>
            Message name
            </summary>
        </member>
        <member name="P:Act.TypeLib.Plugins.MessageAttribute.AutoLoad">
            <summary>
            True if PluginManager should register message automaticly
            </summary>
        </member>
        <member name="T:Act.TypeLib.Networks.Statuses.OnlineStatus">
            <summary>
            Act online status
            </summary>
        </member>
        <member name="T:Act.TypeLib.Roster.EContactElements">
            <summary>
            Contact element attribute enum
            </summary>
        </member>
        <member name="F:Act.TypeLib.Roster.EContactElements.NetworkId">
            <summary>
            Contact network id
            </summary>
        </member>
        <member name="F:Act.TypeLib.Roster.EContactElements.Attributes">
            <summary>
            Contact attributes
            </summary>
        </member>
        <member name="F:Act.TypeLib.Roster.EContactElements.None">
            <summary>
            Used as error indicator
            </summary>
        </member>
        <member name="T:Act.TypeLib.Roster.Contact">
            <summary>
            Represents single roster contact
            </summary>
        </member>
        <member name="F:Act.TypeLib.Roster.Contact._contactId">
            <summary>
            Contact internal id
            </summary>
        </member>
        <member name="F:Act.TypeLib.Roster.Contact._contactNetworkId">
            <summary>
            Contact identificator in network
            </summary>
        </member>
        <member name="F:Act.TypeLib.Roster.Contact._attributes">
            <summary>
            Contact attributes (First name, last name, etc)
            </summary>
        </member>
        <member name="M:Act.TypeLib.Roster.Contact.#ctor">
            <summary>
            Empty constructor
            </summary>
        </member>
        <member name="M:Act.TypeLib.Roster.Contact.#ctor(System.Guid,System.String,System.Collections.Generic.SortedList{System.String,System.String})">
            <summary>
            Constructor
            </summary>
            <param name="contactId">Internal contact identificator</param>
            <param name="contactNetworkId">Contact identificator in network</param>
            <param name="attributes">Contact attributes (nickname, first and last name, etc..</param>
        </member>
        <member name="M:Act.TypeLib.Roster.Contact.Equals(System.Object)">
            <summary>
            Checks equality
            </summary>
            <param name="obj">Object</param>
            <returns>True if equal</returns>
        </member>
        <member name="M:Act.TypeLib.Roster.Contact.GetHashCode">
            <summary>
            Generating hash code
            </summary>
            <returns>Hash code</returns>
        </member>
        <member name="M:Act.TypeLib.Roster.Contact.op_Equality(Act.TypeLib.Roster.Contact,Act.TypeLib.Roster.Contact)">
            <summary>
            Check equality of to NetworkAccounts
            </summary>
            <param name="a">RosterContact</param>
            <param name="b">RosterContact</param>
            <returns>True if equal</returns>
        </member>
        <member name="M:Act.TypeLib.Roster.Contact.op_Inequality(Act.TypeLib.Roster.Contact,Act.TypeLib.Roster.Contact)">
            <summary>
            Check equality of to NetworkAccounts
            </summary>
            <param name="a">NetworkAccount</param>
            <param name="b">NetworkAccount</param>
            <returns>True if not equal</returns>
        </member>
        <member name="P:Act.TypeLib.Roster.Contact.ContactId">
            <summary>
            Contact internal id
            </summary>
        </member>
        <member name="P:Act.TypeLib.Roster.Contact.ContactNetworkId">
            <summary>
            Contact identificator in network
            </summary>
        </member>
        <member name="P:Act.TypeLib.Roster.Contact.Attributes">
            <summary>
            Contact attributes (First name, last name, etc)
            </summary>
        </member>
        <member name="T:Act.TypeLib.Networks.NetworkDescription">
            <summary>
            Act network description
            </summary>
        </member>
        <member name="F:Act.TypeLib.Networks.NetworkDescription._networkId">
            <summary>
            Internal network id
            </summary>
        </member>
        <member name="F:Act.TypeLib.Networks.NetworkDescription._networkName">
            <summary>
            network name
            </summary>
        </member>
        <member name="F:Act.TypeLib.Networks.NetworkDescription._networkUserId">
            <summary>
            Users id in network
            </summary>
        </member>
        <member name="M:Act.TypeLib.Networks.NetworkDescription.#ctor">
            <summary>
            Constructor
            </summary>
        </member>
        <member name="M:Act.TypeLib.Networks.NetworkDescription.Equals(System.Object)">
            <summary>
            Checks equality
            </summary>
            <param name="obj">Object</param>
            <returns>True if equal</returns>
        </member>
        <member name="M:Act.TypeLib.Networks.NetworkDescription.GetHashCode">
            <summary>
            Generating hash code
            </summary>
            <returns>Hash code</returns>
        </member>
        <member name="M:Act.TypeLib.Networks.NetworkDescription.op_Equality(Act.TypeLib.Networks.NetworkDescription,Act.TypeLib.Networks.NetworkDescription)">
            <summary>
            Check equality of to NetworkAccounts
            </summary>
            <param name="a">NetworkAccount</param>
            <param name="b">NetworkAccount</param>
            <returns>True if equal</returns>
        </member>
        <member name="M:Act.TypeLib.Networks.NetworkDescription.op_Inequality(Act.TypeLib.Networks.NetworkDescription,Act.TypeLib.Networks.NetworkDescription)">
            <summary>
            Check equality of to NetworkAccounts
            </summary>
            <param name="a">NetworkAccount</param>
            <param name="b">NetworkAccount</param>
            <returns>True if not equal</returns>
        </member>
        <member name="P:Act.TypeLib.Networks.NetworkDescription.NetworkId">
            <summary>
            Internal network id
            </summary>
        </member>
        <member name="P:Act.TypeLib.Networks.NetworkDescription.NetworkName">
            <summary>
            network name
            </summary>
        </member>
        <member name="P:Act.TypeLib.Networks.NetworkDescription.NetworkUserId">
            <summary>
            Users id in network
            </summary>
        </member>
    </members>
</doc>