VENICE XML-RPC METHODS REFERENCE

Session APIs

venice:session.create

Parameters: None

Returns: string session-ID

Creates a new session for use with Venice XML-RPC. This should be the first call made by any application working with Venice XML-RPC sessions. The new session will be created with the anonymous user context.

venice:session.destroy

Parameters: string session-ID

Returns: boolean TRUE (on success)

Destroys a session created with venice:session.create. Make sure and call this on all sessions allocated with venice:session.create, to minimize unnecessary consumption of system resources.

venice:session.login

Parameters: string session-ID, string username, string password

Returns: boolean TRUE (on success)

Authenticates the user to change the user context associated with a session. This is usually required to access most functionality in Venice, as the anonymous user has very little capability.

Conferencing APIs – Conference Level

venice:conferencing.conference.name

Parameters: string session-ID, community, conference [, string new-name]

community may be specified as either integer community-ID or string community-alias

conference may be specified as either integer conference-ID or string conference-alias

Returns: string name

Retrieves or sets the name of the specified conference.

Conferencing APIs – Topic Level

venice:conferencing.topic.postMessage

Parameters: string session-ID, community, conference, integer topic-number, string pseud, string text [, string mode]

community may be specified as either integer community-ID or string community-alias

conference may be specified as either integer conference-ID or string conference-alias

Returns: integer message-number

Posts a new message in the specified topic. The pseud and text parameters specify the content of the new message.

If present, the mode parameter may be either “normal” or “email”. If not specified, it defaults to “normal”. This affects the formatting performed on the incoming text prior to storing it in the database.

On success, the message number of the new post within that topic is returned.

Conferencing APIs – Message Level

venice:conferencing.message.attach

Parameters: string session-ID, community, conference, integer topic-number, integer message-number, string mime-type, string filename, base64 data

Returns: boolean TRUE (on success)

Attaches post data to a message. The post data may be no longer than 1 megabyte in length. It is added with the specified mime-type and attachment filename.

2004-07-20T00:27:43