The FooDoo Lounge

Address Book 3.1.1 Dictionary

Copyright © 2002-2003 Apple Computer, Inc. All rights reserved.

Index

  1. Standard Suite
  2. Text Suite
  3. Address Book Script Suite

Standard Suite: Common classes and commands for most applications.

Classes:

Class application: An application's top level scripting object.

Plural form:

applications

Elements:

window by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

document by name, by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

version Unicode text [r/o] -- The version of the application.

frontmost boolean [r/o] -- Is this the frontmost (active) application?

name Unicode text [r/o] -- The name of the application.

Class color: A color.

Plural form:

colors

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

Class document: A document.

Plural form:

documents

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

modified boolean [r/o] -- Has the document been modified since the last save?

path Unicode text -- The document's path.

name Unicode text -- The document's name.

Class item: A scriptable object.

Plural form:

items

Properties:

class type class [r/o] -- The class of the object.

properties record -- All of the object's properties.

Class window: A window.

Plural form:

windows

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

zoomed boolean -- Whether the window is currently zoomed.

miniaturized boolean -- Whether the window is currently miniaturized.

name Unicode text -- The full title of the window.

floating boolean [r/o] -- Whether the window floats.

modal boolean [r/o] -- Whether the window is the application's current modal window.

miniaturizable boolean [r/o] -- Whether the window can be miniaturized.

visible boolean -- Whether the window is currently visible.

closeable boolean [r/o] -- Whether the window has a close box.

resizable boolean [r/o] -- Whether the window can be resized.

zoomable boolean [r/o] -- Whether the window can be zoomed.

id integer [r/o] -- The unique identifier of the window.

bounds bounding rectangle -- The bounding rectangle of the window.

titled boolean [r/o] -- Whether the window has a title bar.

index integer -- The index of the window in the back-to-front window ordering.

document document [r/o] -- The document whose contents are being displayed in the window.

Events:

close: Close an object.

close reference -- the object for the command

[saving yes/no/ask] -- Specifies whether changes should be saved before closing.

[saving in alias] -- The file in which to save the object.

count: Return the number of elements of a particular class within an object.

count reference -- the object for the command

[each type class] -- The class of objects to be counted.

Result: integer -- the reply for the command

delete: Delete an object.

delete reference -- the object for the command

duplicate: Copy object(s) and put the copies at a new location.

duplicate reference -- the object for the command

to location reference -- The location for the new object(s).

[with properties record] -- Properties to be set in the new duplicated object(s).

exists: Verify if an object exists.

exists reference -- the object for the command

Result: boolean -- the reply for the command

get: Get the data for an object.

get reference -- the object for the command

Result: anything -- the reply for the command

make: Make a new object.

make

[with properties record] -- The initial values for properties of the object.

new type class -- The class of the new object.

[with data anything] -- The initial data for the object.

[at location reference] -- The location at which to insert the object.

Result: reference -- the reply for the command

move: Move object(s) to a new location.

move reference -- the object for the command

to location reference -- The new location for the object(s).

open: Open an object.

open alias -- The file(s) to be opened.

print: Print an object.

print alias -- The file(s) or document(s) to be printed.

quit: Quit an application.

quit reference -- the object for the command

[saving yes/no/ask] -- Specifies whether changes should be saved before quitting.

save: Save an object.

save reference -- the object for the command

[as Unicode text] -- The file type in which to save the data.

[in alias] -- The file in which to save the object.

set: Set an object's data.

set reference -- the object for the command

to anything -- The new value.

Text Suite: A set of basic classes for text processing.

Classes:

Class attachment: Represents an inline text attachment. This class is used mainly for make commands.

Elements:

character by numeric index, before/after another element, as a range of elements, satisfying a test

attribute run by numeric index, before/after another element, as a range of elements, satisfying a test

attachment by numeric index, before/after another element, as a range of elements, satisfying a test

word by numeric index, before/after another element, as a range of elements, satisfying a test

paragraph by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> text [r/o] -- All of the properties of the superclass.

file name Unicode text -- The path to the file for the attachment

Class attribute run: This subdivides the text into chunks that all have the same attributes.

Plural form:

attribute runs

Elements:

character by numeric index, before/after another element, as a range of elements, satisfying a test

attribute run by numeric index, before/after another element, as a range of elements, satisfying a test

attachment by numeric index, before/after another element, as a range of elements, satisfying a test

word by numeric index, before/after another element, as a range of elements, satisfying a test

paragraph by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

size integer -- The size in points of the first character.

font Unicode text -- The name of the font of the first character.

color color -- The color of the first character.

Class character: This subdivides the text into characters.

Plural form:

characters

Elements:

character by numeric index, before/after another element, as a range of elements, satisfying a test

attribute run by numeric index, before/after another element, as a range of elements, satisfying a test

attachment by numeric index, before/after another element, as a range of elements, satisfying a test

word by numeric index, before/after another element, as a range of elements, satisfying a test

paragraph by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

size integer -- The size in points of the first character.

font Unicode text -- The name of the font of the first character.

color color -- The color of the first character.

Class paragraph: This subdivides the text into paragraphs.

Plural form:

paragraphs

Elements:

character by numeric index, before/after another element, as a range of elements, satisfying a test

attribute run by numeric index, before/after another element, as a range of elements, satisfying a test

attachment by numeric index, before/after another element, as a range of elements, satisfying a test

word by numeric index, before/after another element, as a range of elements, satisfying a test

paragraph by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

size integer -- The size in points of the first character.

font Unicode text -- The name of the font of the first character.

color color -- The color of the first character.

Class text: Rich (styled) text

Elements:

character by numeric index, before/after another element, as a range of elements, satisfying a test

attribute run by numeric index, before/after another element, as a range of elements, satisfying a test

attachment by numeric index, before/after another element, as a range of elements, satisfying a test

word by numeric index, before/after another element, as a range of elements, satisfying a test

paragraph by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

size integer -- The size in points of the first character.

font Unicode text -- The name of the font of the first character.

color color -- The color of the first character.

Class word: This subdivides the text into words.

Plural form:

words

Elements:

character by numeric index, before/after another element, as a range of elements, satisfying a test

attribute run by numeric index, before/after another element, as a range of elements, satisfying a test

attachment by numeric index, before/after another element, as a range of elements, satisfying a test

word by numeric index, before/after another element, as a range of elements, satisfying a test

paragraph by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

size integer -- The size in points of the first character.

font Unicode text -- The name of the font of the first character.

color color -- The color of the first character.

Address Book Script Suite: commands and classes for Address Book scripting.

Classes:

Class AIM Handle: User name for America Online (AOL) messaging.

Plural form:

AIM handles

Properties:

<Inheritance> contact info [r/o] -- All of the properties of the superclass.

Class ICQ handle: User name for ICQ messaging.

Plural form:

ICQ handles

Properties:

<Inheritance> contact info [r/o] -- All of the properties of the superclass.

Class Jabber handle: User name for Jabber messaging.

Plural form:

Jabber handles

Properties:

<Inheritance> contact info [r/o] -- All of the properties of the superclass.

Class MSN handle: User name for Microsoft Network (MSN).

Plural form:

MSN handles

Properties:

<Inheritance> contact info [r/o] -- All of the properties of the superclass.

Class Yahoo handle: User name for Yahoo messaging.

Plural form:

Yahoo handles

Properties:

<Inheritance> contact info [r/o] -- All of the properties of the superclass.

Class address: Address for the given record.

Plural form:

addresses

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

country Unicode text -- Country part of the address.

street Unicode text -- Street part of the address, multiple lines separated by carriage returns.

zip Unicode text -- Zip or postal code of the address.

state Unicode text -- State, Province, or Region part of the address.

id Unicode text -- unique identifier for this address.

city Unicode text -- City part of the address.

country code Unicode text -- Country code part of the address (should be a two character iso country code).

label Unicode text -- Label.

Class application: Users address book database

Elements:

group by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

person by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

window by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

document by name, by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

<Inheritance> application [r/o] -- All of the properties of the superclass.

unsaved boolean [r/o] -- Does the Address Book have any unsaved changes?

default country code Unicode text [r/o] -- Returns the default country code that the user uses for there addresses.

selection list -- Currently selected entries

my card person -- Returns my card in the address book database.

Class contact info: Container object in the database, holds a key and a value

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

label Unicode text -- Label is the label associated with value like "work", "home", etc.

id Unicode text [r/o] -- unique identifier for this entry, this is persistant, and stays with the record.

value anything -- Value.

Class custom date: Arbitrary date associated with this person.

Plural form:

custom dates

Properties:

<Inheritance> contact info [r/o] -- All of the properties of the superclass.

Class email: Email address for a person.

Plural form:

emails

Properties:

<Inheritance> contact info [r/o] -- All of the properties of the superclass.

Class entry: A entry in the address book database

Plural form:

entries

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

id Unicode text [r/o] -- unique identifier for this record, this is persistant, and stays with the record.

modification date date [r/o] -- when the contact was last modified.

creation date date [r/o] -- when the contact was creation.

Class group: A Group Record in the address book database

Plural form:

groups

Elements:

group by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

person by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

Properties:

<Inheritance> entry [r/o] -- All of the properties of the superclass.

name Unicode text -- The name of this group.

Class person: A Person Record in the address book database.

Plural form:

people

Elements:

address by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

AIM Handle by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

group by name, by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

email by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

Yahoo handle by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

MSN handle by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

related name by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

ICQ handle by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

phone by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

Jabber handle by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

custom date by numeric index, before/after another element, as a range of elements, satisfying a test, by ID

Properties:

<Inheritance> entry [r/o] -- All of the properties of the superclass.

image TIFF picture -- Image for person.

middle name Unicode text -- The Middle name of this person.

phonetic last name Unicode text -- The Phonetic Version of the Last name of this person.

name Unicode text [r/o] -- First/Last name of the person, uses the preference setting in Address Book.

organization Unicode text -- Organization that the person works for.

department Unicode text -- Department that the person works for.

suffix Unicode text -- The Suffix of this person.

note Unicode text -- Notes for this person.

last name Unicode text -- The Last name of this person.

phonetic first name Unicode text -- The Phonetic Version of the First name of this person.

company boolean -- Is the current record a company or an person.

birth date date -- The Birth date of this person.

vcard Unicode text [r/o] -- Person information in vCard format, this always returns a card in version 3.0 format.

title Unicode text -- The title of this person.

job title Unicode text -- The Job title of this person.

nickname Unicode text -- The Nickname of this person.

phonetic middle name Unicode text -- The Phonetic Middle name of this person.

first name Unicode text -- The First name of this person.

home page Unicode text -- The Home page of this person.

maiden name Unicode text -- The Maiden name of this person.

Class phone: Phone number for a person.

Plural form:

phones

Properties:

<Inheritance> contact info [r/o] -- All of the properties of the superclass.

Class related name: Other names related to this person.

Plural form:

related names

Properties:

<Inheritance> contact info [r/o] -- All of the properties of the superclass.

Events:

action property: RollOver - Which property is this roll over is associated with (Properties can be one of phone,email,aim,jabber,msn,yahoo,icq,address,date,related name,home page,birth date,maiden name)

action property

Result: Unicode text -- the reply for the command

action title: RollOver - Returns the title that will be placed in the menu for this roll over

action title

for person -- Currently selected person.

with anything -- property that that was returned from the "action property" handler.

Result: Unicode text -- the reply for the command

add: Add a child object.

add entry -- object to add.

to reference -- where to add this child to.

perform action: RollOver - Performs the action on the given person and value

perform action

for person -- Currently selected person.

with anything -- property that that was returned from the "action property" handler.

Result: boolean -- the reply for the command

remove: Remove a child object.

remove entry -- object to add.

from reference -- where to remove this child from.

save addressbook: Save all the current Address Book.

save addressbook reference -- the object for the command

should enable action: RollOver - Returns if the roll over should be the given person and value

should enable action

for person -- Currently selected person.

with anything -- property that that was returned from the "action property" handler.

Result: boolean -- the reply for the command

 

|| url: http://www.foodoo.sunreal.com.au/info/dictionaries/AddressBook_311_asDict.html
|| created: 5-Aug-04, 2:34 PM; updated: 5-Aug-04, 2:28 PM
|| size: 81299 bytes