4.1 Journal Object for a Telephone Call Example
A user creates a journal entry to track a telephone call. The user records the start and end times, puts notes in the body, and links a contact and company. The following is a description of what a client might do to accomplish Joe's intentions and the responses a server might return. For information about remote operations (ROPs), see [MS-OXCPRPT] and [MS-OXCMSG].
Before manipulating a Journal object, the client asks the server to map named properties to property IDs, by sending a RopGetPropertyIDsFromNames ROP request ([MS-OXCROPS] section 2.2.8.1).
|
Property |
Property set GUID |
LID |
|---|---|---|
|
PidLidCommonStart ([MS-OXCMSG] section 2.2.1.18) |
{00062008-0000-0000-C000-000000000046} |
0x00008516 |
|
PidLidCommonEnd ([MS-OXCMSG] section 2.2.1.19) |
{00062008-0000-0000-C000-000000000046} |
0x00008517 |
|
PidLidCompanies (section 2.2.2.4) |
{00062008-0000-0000-C000-000000000046} |
0x00008539 |
|
PidLidContacts ([MS-OXCMSG] section 2.2.1.59.2) |
{00062008-0000-0000-C000-000000000046} |
0x0000853A |
|
PidLidContactLinkName ([MS-OXCMSG] section 2.2.1.59.3) |
{00062008-0000-0000-C000-000000000046} |
0x00008586 |
|
PidLidContactLinkEntry ([MS-OXCMSG] section 2.2.1.59.1) |
{00062008-0000-0000-C000-000000000046} |
0x00008585 |
|
PidLidContactLinkSearchKey ([MS-OXCMSG] section 2.2.1.59.4) |
{00062008-0000-0000-C000-000000000046} |
0x00008584 |
|
PidLidLogTypeDesc (section 2.2.1.2) |
{0006200A-0000-0000-C000-000000000046} |
0x00008712 |
|
PidLidLogType (section 2.2.1.1) |
{0006200A-0000-0000-C000-000000000046} |
0x00008700 |
|
PidLidLogStart (section 2.2.1.3) |
{0006200A-0000-0000-C000-000000000046} |
0x00008706 |
|
PidLidLogEnd (section 2.2.1.4) |
{0006200A-0000-0000-C000-000000000046} |
0x00008708 |
|
PidLidLogDuration (section 2.2.1.5) |
{0006200A-0000-0000-C000-000000000046} |
0x00008707 |
|
PidLidLogFlags (section 2.2.1.6) |
{0006200A-0000-0000-C000-000000000046} |
0x0000870C |
|
PidLidLogDocumentPrinted (section 2.2.1.7) |
{0006200A-0000-0000-C000-000000000046} |
0x0000870E |
|
PidLidLogDocumentSaved (section 2.2.1.8) |
{0006200A-0000-0000-C000-000000000046} |
0x0000870F |
|
PidLidLogDocumentRouted (section 2.2.1.9) |
{0006200A-0000-0000-C000-000000000046} |
0x00008710 |
|
PidLidLogDocumentPosted (section 2.2.1.10) |
{0006200A-0000-0000-C000-000000000046} |
0x00008711 |
The server sends a RopGetPropertyIDsFromNames ROP response with the following property IDs, which will be used in the example that follows. (The actual property IDs are at the discretion of the server.)
|
Property |
Property ID |
|---|---|
|
PidLidCommonStart |
0X81BD |
|
PidLidCommonEnd |
0X81BC |
|
PidLidCompanies |
0X800C |
|
PidLidContacts |
0X8019 |
|
PidLidContactLinkName |
0X802B |
|
PidLidContactLinkEntry |
0X82F6 |
|
PidLidContactLinkSearchKey |
0X82F7 |
|
PidLidLogTypeDesc |
0X8230 |
|
PidLidLogType |
0X801A |
|
PidLidLogStart |
0X8233 |
|
PidLidLogEnd |
0X8234 |
|
PidLidLogDuration |
0X8235 |
|
PidLidLogFlags |
0X8236 |
|
PidLidLogDocumentPrinted |
0X8238 |
|
PidLidLogDocumentSaved |
0X8239 |
|
PidLidLogDocumentRouted |
0X823A |
|
PidLidLogDocumentPosted |
0X823B |
To create a Journal object, the client uses the RopCreateMessage ROP ([MS-OXCROPS] section 2.2.6.2). The server returns a handle to a Message object.
After the user has input his content for the Journal object, the client transmits the data to the server by using the RopSetProperties ROP ([MS-OXCROPS] section 2.2.8.6). For information about the property types in the following table, see [MS-OXCDATA] section 2.11.1.
|
Property |
Property ID |
Property type |
Value |
|---|---|---|---|
|
PidLidCommonStart |
0x81bd |
0x0040 (PtypTime) |
2008/02/20 23:02:00.000 |
|
PidLidCommonEnd |
0x81bc |
0x0040 |
2008/02/20 23:12:00.000 |
|
PidLidCompanies |
0x800c |
0X101F (PtypMultipleString ([MS-OXCDATA] section 2.11.1)) |
[1 entry] "Contoso Pharmaceuticals" |
|
PidLidContacts |
0x8019 |
0X101F |
[1 entry] "Adam Barr" |
|
PidLidContactLinkName |
0x802b |
0X001F (PtypString) |
"Adam Barr" |
|
PidLidContactLinkEntry |
0x82f6 |
0x0102 (PtypBinary) |
*(See note following table) |
|
PidLidContactLinkSearchKey |
0x82f7 |
0x0102 |
**(See note following table) |
|
PidLidLogTypeDesc |
0x8230 |
0X001F |
"Phone call" |
|
PidLidLogType |
0x801a |
0X001F |
"Phone call" |
|
PidLidLogStart |
0x8233 |
0x0040 |
2008/02/20 23:02:00.000 |
|
PidLidLogEnd |
0x8234 |
0x0040 |
2008/02/20 23:12:00.000 |
|
PidLidLogDuration |
0x8235 |
0x0003 (PtypInteger32) |
0x0000000A |
|
PidLidLogFlags |
0x8236 |
0x0003 |
0x00000000 |
|
PidLidLogDocumentPrinted |
0x8238 |
0X000B (PtypBoolean) |
0x00 |
|
PidLidLogDocumentSaved |
0x8239 |
0X000B |
0x00 |
|
PidLidLogDocumentRouted |
0x823a |
0X000B |
0x00 |
|
PidLidLogDocumentPosted |
0x823b |
0X000B |
0x00 |
|
PidTagRtfCompressed ([MS-OXCMSG] section 2.2.1.58.4) |
0x1009 |
0x0102 |
***(See note following table) |
|
PidTagIconIndex ([MS-OXOMSG] section 2.2.1.10) |
0x1080 |
0x0003 |
0x0000060A |
* The PidLidContactLinkEntry property contains a representation of the contact link, as described in [MS-OXCMSG] section 2.2.1.59.1.
** The PidLidContactLinkSearchKey property contains a representation of the contact link, as described in [MS-OXCMSG] section 2.2.1.59.4.
*** The PidTagRtfCompressed property ([MS-OXCMSG] section 2.2.1.58.4) contains the compressed Rich Text Format (RTF) representation of the body, as described in [MS-OXRTFCP].
When the user saves the changes, the client commits the properties on the server by using the RopSaveChangesMessage ROP ([MS-OXCROPS] section 2.2.6.3) and then releases the Journal object by using the RopRelease ROP ([MS-OXCROPS] section 2.2.15.3).
The values of some properties will change during the processing of the RopSaveChangesMessage ROP, but the properties specified in this document will not change.