addBuddy(newBuddy)

          

newBuddy:   String. The name of the new buddy.

          

Add new buddy to the buddy list.

---

connect(buddy)

          

buddy:   String. The name of the buddy.

          

Connect to a buddy.

---

deleteBuddy(buddy)

          

buddy:   String. The name of the buddy.

          

Delete buddy from the buddy list.

---

download(type, playlist, file)

          

type:   integer. type of the link.

playlist:   String. The name of the playlist link.

file:   String. The name of the file.

          

Download the file.

---

fetchLink(type, linkValue, jsobject)

          

type:   integer. type of the link.

linkValue:   String. The value of the link.

jsobject:   JavaScript fetch callback object.

          

Include this link in UCeeCtrl managed links and fetch the properties of the link. Use the search methods if you don't know the link value exactly.

---

fetchPeerLink(type, userURL)

          

type:   integer. type of the link.

userURL:   String. The value of the link.

          

Include this link in UCeeCtrl managed peer links and reach out to the peer.

---

getContent(type, playlist, file, jsobject)

          

type:   integer. type of the link.

playlist:   String. The name of the playlist link.

file:   String. The name of the file.

jsobject:   JavaScript getContent callback object.

          

Get file.

---

getPlayListByLinkValue(type, linkValue)

          

type:   integer. type of the link.

linkValue:   String. The value of the link.

          

Return name of the playlist by its linkk value.

---

getPeer(type, index)

          

type:   integer. type of the link.

index:   integer. index of the link.

          

Return name of the peer on the buddy or reach-out list. Same as item.

---

getPlayList(type, index)

          

type:   integer. type of the link.

index:   integer. index of the link.

          

Return name of the playlist on the myPC, Public, Ad, or Camera lists. same as item.

---

getPlayListFile(type, index, playlist)

          

type:   integer. type of the link.

index:   integer. index of the file.

playlist:   String. The name of the playlist link.

          

Return name of the file on the playlist.

---

item(type, index)

          

type:   integer. type of the link.

index:   integer. index of the link.

          

Return name of the link.

---

itemByLinkValue(type, linkValue)

          

type:   integer. type of the link.

linkValue:   String. The value of the link.

          

Return name of the link by its linkk value.

---

logon()

          

log on to UCee. See also AutoLogOn.

---

moveToBuddyList(peer)

          

peer:   String. The name of the peer link.

          

Move peer from reach out list to buddy list.

---

play(type, playlist, file)

          

type:   integer. type of the link.

buddy:   String. The name of the playlist link.

playlist:   String. the name of the file.

          

Play the file.

---

registerNewUser()

          

Register a new UCee user. Set UserName and Password before the call.

---

selectChildItem(type, parentItem, childItem)

          

type:   integer. type of the link.

parentItem:   String. The name of the parent link.

childItem:   String. The name of the child link.

          

Notify UCee control the link is clicked.

---

selectItem(type, link)

          

type:   integer. type of the link.

link:   the name of the link.

          

Notify UCee control the link is clicked.

---

sendToBuddy(type, buddy, playlist)

          

type:   integer. type of the link.

buddy:   String. The name of the buddy.

playlist:   String. the name of the playlist link.

          

Send a playlist link to a buddy.

---

startService()

          

Start UCee braodcast.

deletePlaylist(playlist)

          

playlist:   the name of the link.

          

Delete the playlist.

---

newFile(text, jsobject)

          

text:   String.

jsobject:   JavaScript play list object.

          

Create a new file, fill it with text. Then create a new playlist consists of this single file.

---

newPlaylist(jsobject)

          

jsobject:   JavaScript play list object.

          

Create a new playlist.

AggregatorName

          

Your web site name. You are the links aggregator.

---

CategoryCode

          

The category of the links.

---

RegionCode

          

The language/region of the links.

search(keys)

          

keys:  String. key words/phrases separated by \n\r.

          

Uses AggregatorName, RegionCode, and CategoryCode set previously.

---

searchByAggregator(linkAggr, keys)

          

linkAggr:   String. aggregator's user name.

keys:   String. key words/phrases separated by \n\r.

---

searchByCategory(categoryCode, keys)

          

categoryCode:   integer. category of the links.

keys:   String. key words/phrases separated by \n\r.

---

searchByRegion(regionCode, keys)

          

regionCode:   integer. language/region of the links.

keys:   String. key words/phrases separated by \n\r.

---

searchByUser(user, keys)

          

user:   String. user name.

keys:   String. key words/phrases separated by \n\r.

AutoLogon

          

Boolean

Log on to UCee automatically when UCeeCtrl is loaded. Default is true.

---

LogonOK

          

Boolean

Logon ok. Get only.

---

Password

          

String

Log on user password.

---

SaveUserNamePassword

          

Boolean

Save user name and password in the local computer. Default is true.

---

UserName

          

String

Log on user name.

---

UserURL

          

String

Link value of the current user. Get only.

about()

          

Show the about dialog.

---

addBuddyDialog()

          

Show the add buddy dialog.

---

selectFileDialog(title)

          

title:   String. The window title of the file dialog.

          

Show the the file dialog and return the selected file path.

---

sendToBuddyDialog(type, playlist)

          

type:   integer. type of the link.

playlist:   String. The name of the playlist link.

          

Show the send-to-buddy dialog.

---

uploadDialog()

          

Show the upload dialog.

getRegStatus(type, buddy)

          

type:   integer. type of the link.

buddy:   String. The name of the buddy.

          

Get peer status.

---

getPhoneStatus(type, buddy)

          

type:   integer. type of the link.

buddy:   String. The name of the buddy.

          

Get peer phone status.

---

getLocationStatus(type, buddy)

          

type:   integer. type of the link.

buddy:   String. The name of the buddy.

          

Get peer location status.

BackgroundColor

          

Integer. Usually in the format 0xbbggrr.

The color of the UCee window background.

---

BorderColor

          

Integer. Usually in the format 0xbbggrr.

The color of the UCee window border.

---

BottomColor

          

Integer. Usually in the format 0xbbggrr.

The color of the UCee window bottom where control buttons reside.

---

CurrentPage

          

Integer. The current page.

---

NoButton

          

Boolean. Default true.

Do not show the buttons.

---

Title

          

String

The title of the UCee window.

---

TitleBarColor

          

Integer. Usually in the format 0xbbggrr.

The color of the UCee window title bar.

Javascript fetchLink callback object

          

See fetchLink.

The object has two callback js functions.

          

startFetch(linkValue)

          

linkValue:   String. The link value.

          

stopFetch(rc, linkValue)

          

rc:   int. Return code. 0 success.

linkValue:   String. The link value.

          

---

Javascript getContent callback object

          

See getContent.

The object has three callback js functions.

          

errMsg(msg)

          

msg:   String. The error message.

          

setDone(rc, text, base64, ext)

          

rc:   int. Return code. 0 success.

text:   String. This is set if the link is a text file.

base64:   String. This is set if the link is not a text file. Use data url to display it.

ext:   The extension of the file. This may help you set the mime type of the data url.

          

setProgress(progress)

          

progress:   double. The completion fraction.

          

---

playlist object

          

See newFile and newPlaylist.

The object has the following js properties.

          

aggregatorName:   String. The name of your web site. Used in search. Only public playlist is searchable.

buddies:   String. An array of the names of the buddies who will share this playlist.

contact:   String. The contact person of the playlist. One of the link properties accessible by others. The playlist must be public.

description:   String. A 200-character limit text. This text is delivered directly from UCee like a conventional web page instead of being fetched from a peer PC. Thus enable people to see it if they haven't installed UCee software. The playlist must be public.

docs:   String. An array of the names of the files.

folder:   String. The path of the folder where the playlist files are.

isFolder:   Boolean. The playlist includes all the files in the folder.

isPublic:   Boolean. The playlist is public.

keywords:   String. An array of the search keywords. Used in search. Only public playlist is searchable.

name:   String. The name of the playlist.

url:   String. The url of the your site. One of the link properties accessible by others. The playlist must be public.

user:   String. Set this if your web site has a user name for the playlist owner. Used in search. Only public playlist is searchable.

          

Properties set by UCeeCtrl on return:  

          

linkValue:   String. The link value of this new playlist.

uce:   String. The path of the link property file.