Home | Software | Tools | Routines | Info | Dictionaries

Keychain Scripting 2.5 Dictionary

© Copyright 2002 Apple Computer Inc., all rights reserved.

Index

1. Standard Suite
   • Classes:
     1. application
   • Events:
     1. count
     2. delete
     3. exists
     4. make
     5. quit
     6. run
2. Keychain Suite
   • Classes:
     1. AppleShare key
     2. Internet key
     3. generic key
     4. key
     5. keychain
   • Events:
     1. lock
     2. unlock

Standard Suite: Common terms for most applications

Classes:

Class application: The Keychain Scripting application

Elements:

keychain by numeric index, by name, satisfying a test

Properties:

name string [r/o] -- the name of the Keychain Scripting application

current keychain reference -- the keychain currently in use (also called the default keychain)

version version [r/o] -- the version of the Keychain Scripting application

Events:

count: Return the number of keychains or keys

count reference -- the object whose elements are to be counted

each type class -- the class of the elements to be counted

Result: integer -- the number of elements

delete: Delete a keychain or key

delete reference -- the element to delete

exists: Verify if the keychain functionality, any keychain, or a key exists

exists reference -- the object in question

Result: boolean -- true if exists, false if not

make: Make a new keychain or key

make

new type class -- the class of the new element

at location reference -- the location at which to insert the element

[with data anything] -- the initial data for the element

[with properties record] -- the initial values for the properties of the element

Result: reference -- to the new object(s)

quit: Quit application

quit

run: Sent to an application when it is double-clicked

run

Keychain Suite: Keychain scriptability.

Classes:

Class AppleShare key: A key to an AppleShare file server

Properties:

<Inheritance> key -- See the class “key” for more properties

zone string -- the AppleTalk zone name (if server is on an AppleTalk network)

address string -- the DNS host name or IP address (if server is on a TCP/IP network)

server string -- the file server name

volume string -- the volume to mount

Class Internet key: A key to an Internet server

Properties:

<Inheritance> key -- See the class “key” for more properties

server string -- the server name

path string -- the path to the file or directory

security domain string -- the security domain

port small integer -- the TCP/IP port number

protocol FTP/HTTP/IRC/NNTP/POP3/SMTP/SOCKS/IMAP/LDAP/AppleTalk/AFP/Telnet/SSH/FTPS/HTTPS/HTTP Proxy/HTTPS Proxy/FTP Proxy/SMB/RTSP/RTSP Proxy/DAAP/EPPC/IPP/NNTPS/LDAPS/TelnetS/IMAPS/IRCS/POP3S/none -- the protocol

authentication NTLM/MSN/DPA/RPA/HTTP digest/HTML form/default -- the authentication scheme

Class generic key: A key to an application or service

Properties:

<Inheritance> key -- See the class “key” for more properties

service string -- the service name

Class key: A key to an application or service

Plural form:

keys

Properties:

name string -- the name of this key

account string -- the account (also known as user name or login name)

creation date date [r/o] -- the time this item was created

modification date date [r/o] -- the time this item was last modified

description string -- the description (or kind) of the key

comment string -- a user-supplied comment about this item

file type type class -- an OSType identifying a data type for which an icon exists

creator type type class -- an OSType identifying the application that created the key

custom icon boolean -- true if this key should use a custom icon, found using creator and file type

invisible boolean -- true if this is an invisible item (not to be displayed)

negative boolean -- true if this is a key which should not be used

password string -- the password

Class keychain: A set of related keys to applications and services

Plural form:

keychains

Elements:

key by numeric index, satisfying a test

Properties:

name string [r/o] -- the name of the keychain

locked boolean [r/o] -- true if the keychain is locked, false if the keychain is unlocked

Events:

lock: Lock a keychain

lock reference -- the keychain to lock (lock all keychains if not specified)

unlock: Unlock a keychain

unlock reference -- the keychain to unlock (unlock current keychain if not specified)

[with password string] -- the password for this keychain

|| url: http://www.foodoo.sunreal.com.au/info/dictionaries/KCScripting_25_asDict.html
|| created: 16-Aug-04, 9:32 PM; updated: 16-Aug-04, 9:32 PM
|| size: 23167 bytes