Groupwise Developer's Guide

More documents

Recommendations

Info

Novell Research Publishers of AppNotes® Novell’s Technical Journal for Implementing, Managing, and Programming to one Net Editor-in-Chief Gamal B. Herbon Managing Editor Ken Neff Senior Editor Edward Liebing Senior Research Engineer Kevin Burnett Editor Rebecca Rousseau Graphics Wes Heaps Online Production Robert Rodriguez This eBook was produced using Adobe FrameMaker 6, Illustrator, Photoshop, and Streamline, QuarkXPress, WebWorks Publisher Professional, Adobe Acrobat 5, and HP LaserJet printers. Editorial Comments Direct any comments or suggestions about the content of this eBook to: Gamal B. Herbon Novell Research Novell, Inc. MS PRV A-231 1800 S. Novell Place Provo, Utah 84606 USA Voice (801) 861-6504 Fax (801) 861-4123 E-mail gherbon@novell.com On the Web The GroupWise Object API Developer’s Guide eBook is accessible on the World Wide Web at http://www.novell.com/ research. Permissions April 15, 2002 464-000063-013 You must obtain permission before reproducing any material from the GroupWise Developer’s Guide in any form. To quote from or reprint any portion, send a written request to Novell Research Editor-in-Chief, 1800 S. Novell Place, Provo, UT, 84606, or fax to (801) 861-4123. Copyright © 2002 by Novell, Inc., Provo, Utah. All rights reserved. Novell, Inc. makes no representations or warranties with respect to the contents or use of these eBooks or of any of the thirdparty products discussed in the eBook. Novell reserves the right to revise these eBooks and to make changes in their content at any time, without obligation to notify any person or entity of such revisions or changes. These eBooks do not constitute an endorsement of the third-party product or products that were tested. Configuration(s) tested or described may or may not be the only available solution. Any test is not a determination of product quality or correctness, nor does it ensure compliance with any federal, state or local requirements. Novell does not warranty products except as stated in applicable Novell product warranties or license agreements.
Dear Readers: Introduction Welcome to this second edition of the AppNotes/DeveloperNet University GroupWise Developer’s Guide. Many of you have liked what we have provided so far, and we are continuing to bring you the material you need. As we continue to release new sections as part of this eBook, please be patient and provide us with feedback on the sections as they come out, and I think the end product will be one that will be quite useful in your development efforts regarding GroupWise. Now, a little about the book. The GroupWise APIs provide a rich set of application tools that can help developers access the power of GroupWise. This book was written to help application developers harness this power. Through a combination of numerous examples and detailed discussions not available elsewhere, its aim is to simplify and take the mystery out of GroupWise development. The book is divided into four main sections. Chapters 1-9 discuss the GroupWise Object API, which gives developers access to the GroupWise data store. Chapters 10-15 present a discussion of GroupWise tokens. These tokens allow developers to “throw” and “catch” many of the same actions that take place within the GroupWise client itself. Chapters 16-19 discuss GroupWise C3POs, which give developers the ability to modify the GroupWise client. C3POs also provide the capability to catch and handle GroupWise events and commands. Finally, Chapters 20 and beyond present a quick survey of the Administrative Object API. This API gives someone with administrative privileges the ability to make GroupWise system level changes, such as adding and deleting GroupWise users. This book should be helpful to all GroupWise developers who use any of these API sets. Because Visual Basic, Delphi, and C++ are all languages used by GroupWise developers, this book will include examples in all three languages. An emphasis is given to Visual Basic and Delphi, since these are the language most often used by GroupWise developers. This release presents the first and third sections, (consisting of Chapters 1-9 and 16-19). Other chapters will be grouped together logically and will be released as we finish them. Check our web site for updated versions. I acknowledge the contributions of the authors, Michael Risch, Sean Kirkby, Bob Good, and Steve Hughes. I also want to acknowledge and thank John Cox and Glade Monson of Novell’s Worldwide Developer Support organization for their efforts. Of course, I acknowledge the hard work of the AppNotes and DeveloperNet University team in editing, and producing this book. I look forward to your feedback on this book and the format. Let me know how you like and what we can do better. Gamal B. Herbon Editor-in-Chief July 2002 1
Page 1: GroupWise® developer’s guide Nov
Page 5 and 6: Chapter 13: (not yet available) Cha
Page 7 and 8: Getting Started with the Object API
Page 9 and 10: COM can be a complicated subject to
Page 11 and 12: Late Binding The GroupWise Object A
Page 13 and 14: Reasons For Using Type Libraries. S
Page 15 and 16: Figure 4: Look up the syntax of the
Page 17 and 18: Setting up C++ In C++, the normal w
Page 19 and 20: Logging in Once you have gotten a r
Page 21 and 22: } vWhenToPrompt, vReserved, &pDIGWA
Page 23 and 24: If JoeUser has multiple accounts -
Page 25 and 26: End If Set gwAccount = Nothing Set
Page 27 and 28: The problem is that the GroupWise O
Page 29 and 30: AccountRights Property One of the i
Page 31 and 32: ProxyAccounts and Proxied Propertie
Page 33 and 34: Archive Properties Non-Collection T
Page 35 and 36: Here is a Visual Basic example that
Page 37 and 38: Summary SynchronizeWithMaster (flag
Page 39 and 40: Folders Folders, like many other co
Page 41 and 42: Exit Sub FldrErr: MsgBox "Folder no
Page 43 and 44: • Account.WorkFolder: Returns the
Page 45 and 46: System Creating a Folder These are
Page 47 and 48: Example in VB: 'gwAccount is a vali
Page 49 and 50: Example in Delphi: //gwAccount is a
Page 51 and 52: Testing a Folder For Folder Rights
Page 53 and 54:
Example in Delphi: //gwAccount is a
Page 55 and 56:
Example in VB: 'gwAccount is a vali
Page 57 and 58:
Removing User Access to a Shared Fo
Page 59 and 60:
This method empties the trash folde
Page 61 and 62:
gwTestMessage1:=gwFoundTrashItems.I
Page 63 and 64:
The Messages Collection The Message
Page 65 and 66:
procedure FindMessagesWithThe2; var
Page 67 and 68:
Messages.Add() You can create eithe
Page 69 and 70:
When linking messages, you pass the
Page 71 and 72:
Set GW = CreateObject("NovellGroupW
Page 73 and 74:
Name Description Skip(NumMessages)
Page 75 and 76:
Item() takes as single parameter ca
Page 77 and 78:
Understanding Message and Message R
Page 79 and 80:
Property Data Type Description Encl
Page 81 and 82:
MessageSubtype.Reply([ClassName as
Page 83 and 84:
Mail The Mail object represents a G
Page 85 and 86:
Although this method requires no pa
Page 87 and 88:
PhoneMessage The PhoneMessage objec
Page 89 and 90:
Setting and Accessing the Propertie
Page 91 and 92:
gwAccount.Refresh; {refresh the dat
Page 93 and 94:
Example in VB: 'gwAccount is a vali
Page 95 and 96:
Example in VB: 'gwMail is a valid M
Page 97 and 98:
Adding Recipients Four different Ad
Page 99 and 100:
Summary In this chapter you learned
Page 101 and 102:
Document References The DocumentRef
Page 103 and 104:
if gwAttachment.ObjType =egwFile th
Page 105 and 106:
Name Data Type Description Starting
Page 107 and 108:
DocNumber is an integer that contai
Page 109 and 110:
Dim gwDocIterator As GroupwareTypeL
Page 111 and 112:
The Document and DocumentVersions O
Page 113 and 114:
The DocumentVersions Object The Doc
Page 115 and 116:
The Retrieve() method will generate
Page 117 and 118:
Document Rights The DocumentAccessR
Page 119 and 120:
The DocumentType Object The key pro
Page 121 and 122:
Manipulating Addresses and Address
Page 123 and 124:
If it can find a match, it is consi
Page 125 and 126:
Property Type Members GroupMembers
Page 127 and 128:
You may also obtain an AddressBook
Page 129 and 130:
Summary 127 In this chapter you lea
Page 131 and 132:
Pre-defined and Custom Field Object
Page 133 and 134:
130 Adding a FieldDefinition to a c
Page 135 and 136:
132 Example in Delphi: //gwAccount
Page 137 and 138:
134 Example in VB: Set gwProjectIDF
Page 139 and 140:
136 Each column represents a proper
Page 141 and 142:
138 Personal AddressBook objects ca
Page 143 and 144:
140 Figure 4: The Microsoft PAB. Th
Page 145 and 146:
142 It’s quite a different list!
Page 147 and 148:
144 Suppose you have a DocumentLibr
Page 149 and 150:
146 Example in Delphi: //gwDocument
Page 151 and 152:
148 Figure 13: Lookup table list. I
Page 153 and 154:
150 Figure 15: Lookup. FieldDefinit
Page 155 and 156:
Related Properties 152 The LookupTa
Page 157 and 158:
154 Figure 18: Values in the Case I
Page 159 and 160:
Summary 156 The ultimate value that
Page 161 and 162:
Filters The Filter Object 158 Like
Page 163 and 164:
160 The properties we are intereste
Page 165 and 166:
Parameter Data Type Description Loc
Page 167 and 168:
164 The following syntax returns ob
Page 169 and 170:
166 The following examples should h
Page 171 and 172:
Summary 168 Basic Expressions Use t
Page 173 and 174:
170 • IconFactory These files may
Page 175 and 176:
172 EventMonitor The EventMonitor o
Page 177 and 178:
Registration 174 Execute Following
Page 179 and 180:
176 Incorrect "C:\WINDOWS\Desktop\s
Page 181 and 182:
178 sAppName := 'Help Desk'; Reg :=
Page 183 and 184:
Customizing Main Menus Customizing
Page 185 and 186:
egin If CompareStr(Context, 'GW.CLI
Page 187 and 188:
The GWMenuAction Object The GWMenuA
Page 189 and 190:
vMenu : variant; vSeparator: varian
Page 191 and 192:
Let’s now take a look at actually
Page 193 and 194:
Return Value It is important to not
Page 195 and 196:
Figure 2: Choose context to modify
Page 197 and 198:
5. The example above will add a men
Page 199 and 200:
The following code adds a “Sample
Page 201 and 202:
Figure 9: C3PO Creation Wizard. 1.
Page 203 and 204:
Figure 13: 5. Continue to add menus
Page 205 and 206:
The GWToolBar.ToolbarItems Property
Page 207 and 208:
'C3PO WIZARD icons.dll can be repla
Page 209 and 210:
Power Tip: ToolbarID You can manipu
Page 211 and 212:
Figure 17: Context to modify toolba
Page 213 and 214:
Summary Figure 20: Finishind the C3
Page 215 and 216:
212 GroupWise calls WantCommand() w
Page 217 and 218:
214 Figure 4: Finishing C3PO Creati
Page 219 and 220:
216 • Alternatively, the Compose
Page 221 and 222:
GroupWise Events 218 Figure 7: Fini
Page 223 and 224:
end; 220 else if CompareText(evt.Pe
Page 225 and 226:
Summary 222 Figure 11: Finishing C3
Page 227 and 228:
224 More About the Button Bar The v
Page 229 and 230:
end; 226 end; if messageid'X00' the
Page 231 and 232:
228 Use The Wizard Our first task i
Page 233 and 234:
The C3PO Server 230 Font.Color = cl
Page 235 and 236:
232 Delphi Example procedure Regist
Page 237 and 238:
234 Adding the Menu Now we will add
Page 239 and 240:
The Form Functions 236 This seems l
Page 241 and 242:
Summary 238 This procedure is doing
show all

Groupwise Developer's Guide

Create successful ePaper yourself

Delete template?

Save as template?