Legacy Document
Important: The information in this document is obsolete and should not be used for new development.
Important: The information in this document is obsolete and should not be used for new development.
CyberSession
An object of the
- Superclasses
ODObject- Subclasses
- none
CyberSessionclass represents a user's access to Cyberdog.Description
The Cyberdog session is a single, global object whose interface provides access to various objects in Cyberdog, including the available Cyberdog services. Any part that calls Cyberdog methods should call theInitCyberdogglobal function (page 188) during its initialization to initialize Cyberdog and create the global session object. Once a Cyberdog session object has been created, you can retrieve it by calling theGetCyberSessionglobal function.When a Cyberdog session is initialized, it loads and keeps track of the available Cyberdog services (page 329). In addition, the Cyberdog session object provides methods for accessing the default notebook, the log, and the Connect To and Preferences dialog boxes. The Cyberdog session also provides access to a number of global Cyberdog utility methods.
The Cyberdog session keeps track of the user's opening of and access to a single, temporary Cyberdog session document, which has a single OpenDoc draft. The root part of the Cyberdog session document never displays itself. During a Cyberdog session, this temporary session document contains all of the display parts that are not contained in other OpenDoc documents.
The Cyberdog session document does not contain the log, the notebook, or any other Cyberdog-related document that can be opened from the Finder. Although these are also OpenDoc documents, they are separate from the session document. However, all documents created by Cyberdog, including the session document, share a single process.
Do not subclass this class.
Methods
This section presents summary descriptions of theCyberSessionmethods grouped according to purpose, followed by detailed descriptions.Initialization and Cleanup
Accessing a Cyberdog Service
ICyberSession- Initializes this session object.
Accessing the OpenDoc Session
CountCyberServices- Retrieves the number of services available to this Cyberdog session.
GetCyberService- Retrieves a Cyberdog service by index.
Connect To Dialog Utilities
GetODSession- Retrieves the OpenDoc session object for this Cyberdog session.
Cyberdog Session Document Utilities
PromptForCyberItem- Displays the Connect To dialog box and returns the Cyberdog item specified by the user.
ShowConnectDialog- Displays the Connect To dialog box.
Cyberdog Item Utilities
CloseCyberDraftWindow- Closes a part window in the Cyberdog session document.
CreatePartInCyberDocument- Creates a new part in a Cyberdog session document.
CreatePartInNewDocument- Creates a new part as a separate OpenDoc document.
GetCyberDraft- Retrieves the draft of the Cyberdog session document.
InstallCyberDocumentMenu- Installs a Document menu customized for Cyberdog display parts contained in the Cyberdog session document.
IsInCyberDraft- Tests whether the specified persistent object is stored in the Cyberdog session document's draft.
Log Utilities
CreateCyberItemFromSU- Creates a Cyberdog item from a storage unit.
CreateCyberItemFromURL- Creates a Cyberdog item for a URL.
CreateProxyItemFromURL- Creates a proxy Cyberdog item for a URL.
FindCyberItemWindow- Retrieves the window that displays a Cyberdog item.
NewCyberItem- Creates a Cyberdog item.
SelectCyberItemWindow- Retrieves and selects the window that displays a Cyberdog item.
Navigator Utilities
AddCyberItemToLog- Adds a Cyberdog item to the log.
ClearLogFinger- Clears the log finger from a Cyberdog item.
GetLog- Retrieves the log part.
IsLogWindowShown- Tests whether the log window is currently displayed.
LogContainsCyberItem- Tests whether a particular Cyberdog item is in the log.
SetLog- Sets the log part and its extension.
SetLogFinger- Sets the log finger to a particular Cyberdog item.
ShowLogWindow- Displays the log window.
Notebook Utilities
AcquireContainingNavigatorPart- Retrieves a frame's containing navigator.
IsContainedInRootNavigatorPart- Tests whether a frame is embedded in a navigator and the navigator is the root part.
Opener Part Utilities
AddCyberItemsToNotebook- Adds a set of Cyberdog items to the notebook.
AddCyberItemToNotebook- Adds a Cyberdog item to the notebook.
GetNotebook- Retrieves the notebook part.
IsNotebookWindowShown- Tests whether the notebook window is currently displayed.
SetNotebook- Sets the current notebook part and its extension.
ShowNotebookWindow- Displays the notebook window.
Preferences Dialog Utilities
CreateCyberPart- Creates a new Cyberdog display part to replace an opener part.
ObtainOpener- Retrieves an opener part to be used for the duration of the opening process for a Cyberdog item.
Type Conversion Utilities
AcquireICInstance- Opens an Internet Config session.
GetConfigReference- Retrieves the Internet configuration specification.
ReleaseICInstance- Releases an Internet configuration instance.
SetConfigReference- Sets the Internet configuration specification.
ShowPreferencesDialog- Displays the Preferences dialog box.
GetCyberItemTypeFromContentType- Converts an OpenDoc value type to a Cyberdog item value type.
GetISOTypeFromMIMEType- Converts a MIME media type to an OpenDoc value type.
Methods
- AcquireContainingNavigatorPart
- AcquireICInstance
- AddCyberItemsToNotebook
- AddCyberItemToLog
- AddCyberItemToNotebook
- ClearLogFinger
- CloseCyberDraftWindow
- CountCyberServices
- CreateCyberItemFromSU
- CreateCyberItemFromURL
- CreateCyberPart
- CreatePartInCyberDocument
- CreatePartInNewDocument
- CreateProxyItemFromURL
- FindCyberItemWindow
- GetConfigReference
- GetCyberDraft
- GetCyberItemTypeFromContentType
- GetCyberService
- GetISOTypeFromMIMEType
- GetLog
- GetNotebook
- GetODSession
- ICyberSession
- InstallCyberDocumentMenu
- IsContainedInRootNavigatorPart
- IsInCyberDraft
- IsLogWindowShown
- IsNotebookWindowShown
- LogContainsCyberItem
- NewCyberItem
- ObtainOpener
- PromptForCyberItem
- ReleaseICInstance
- SelectCyberItemWindow
- SetConfigReference
- SetLog
- SetLogFinger
- SetNotebook
- ShowConnectDialog
- ShowLogWindow
- ShowNotebookWindow
- ShowPreferencesDialog