Platforms to show: All Mac Windows Linux Cross-Platform

Back to IMServiceMBS class.

IMServiceMBS.infoForAllScreenNames as dictionary()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Instant Message MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns information about all people and all accounts currently logged in to the service.

If a person is logged in on multiple accounts (determined by the user's Address Book), this method will return the information for all of the logged-in accounts.

Returns an Array of the dictionaries. Use IMPerson*Key strings for the keys in that dictionary.

Some examples using this method:

IMServiceMBS.infoForPreferredScreenNames as dictionary()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Instant Message MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns information about all people and their primary accounts currently logged in to the service.

If a person is logged in on multiple accounts (determined by the user's Address Book), this method will only return the information for the preferred account. The preferred account is determined by iChat, using a combination of capabilities (video chat capability, audio chat capability, and so on), status (available, idle, away), and other user attributes.

Returns an Array of the dictionaries for all people and is guaranteed to provide only one array entry for any logged-in person. Use IMPerson*Key strings for the keys in that dictionary.

IMServiceMBS.infoForScreenName(name as string) as dictionary

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Instant Message MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns information about the person specified by his/her screenName.

screenName: A string containing the screen name identifier of a person.

Returns a dictionary on success and nil on failure. Use IMPerson*Key strings for the keys in that dictionary.

IMServiceMBS.LocalizedName as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Instant Message MBS MacCocoa Plugin 7.1 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns the user-visible localized name of the service.
Example
dim services() as IMServiceMBS = InstantMessageMBS.allServices

for each service as IMServiceMBS in Services
MsgBox service.LocalizedName
next

Returns a String. Will contain the localized service name, such as "AOL Instant Messenger", "Jabber", or "Bonjour", for example. This string will be localized if required.

IMServiceMBS.LocalizedShortName as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Instant Message MBS MacCocoa Plugin 7.1 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns a shorter version, if available, of the user-visible localized name of the service.
Example
dim services() as IMServiceMBS = InstantMessageMBS.allServices

for each service as IMServiceMBS in Services
MsgBox service.LocalizedShortName
next

Returns a "" on failure. Will return a localized string if required.

IMServiceMBS.Name as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Instant Message MBS MacCocoa Plugin 7.1 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns the fixed canonical name of the service.
Example
dim services() as IMServiceMBS = InstantMessageMBS.allServices

for each service as IMServiceMBS in Services
MsgBox service.Name
next

Returns a "" on failure. This string is not localized.

IMServiceMBS.peopleWithScreenName(screenName as string) as ABPersonMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Instant Message MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns the Address Book person objects that correspond to the person with the screenName matched by screenName.

screenName: An string containing the screen name identifier of a person or persons.

Returns an array of ABPersonMBS objects that match the screen name matched by screenName. Can return an empty array or an array with one or more items.

Returns empty array on failure.

IMServiceMBS.screenNamesForPerson(person as ABPersonMBS) as string()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Instant Message MBS MacCocoa Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns a list of valid screen names for any given person.
Example
// show my screennames on all services

dim AddressBook as new ABAddressBookMBS
dim owner as ABPersonMBS = AddressBook.owner
dim services() as IMServiceMBS = InstantMessageMBS.allServices

for each service as IMServiceMBS in Services
MsgBox service.LocalizedName+":"+EndOfLine+join(service.screenNamesForPerson(owner), EndOfLine)
next

person: An Address Book ABPerson object.
Returns an Array of Strings that are valid screen names for the person specified by person. See Address Book documentation for more information on ABPerson and accessing the user's address book. Can return an empty array or an array with one or more items.

Returns an empty array on failure.

IMServiceMBS.Status as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Instant Message MBS MacCocoa Plugin 7.1 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns the login status of the service.

Returns the appropriate IMServiceStatus number.

The items on this page are in the following plugins: MBS MacCocoa Plugin.


The biggest plugin in space...