Newton Developer Technical Information: Newton Programmer's Guide: 2.1 OS Addendum /

Chapter 10 - eMate Multi-User Mode / Reference

Functions and Methods /

GetBackupSoupNames

app:GetBackupSoupNames()

Returns an array of strings corresponding to the names of this application's soups for the current user.

return value

An array of one or more soup name strings corresponding to the current user.

DISCUSSION

You must supply this method in your application if you want to support multi-user mode.

This method is called by the Classroom Dock application when the user wants to back up his or her data to the classroom server.

If the unit is in Full Newton System mode, this method should return the name of the generic (accessible to all users) application soup.

The following line of code shows one way to construct an appropriate return value for the *GetBackupSoupNames method.

 [

GetRoot().HomePage:GenSoupName(allSoups.myApp.soupBaseName, 
   if GetUserConfig('KSimpleMode) 
      then GetUserConfig('KCurrentUser) )
 ];

This example uses the *GenSoupName method of the HomePage application to construct an appropriate soup name string. This method returns a string by concatenating a base soup name with the current user name, or with nil if the unit is not in Classroom mode. Note that the application identified as HomePage in the root frame contains the Teacher Setup slip, controls display of the simplified Extras Drawer when the unit is in Classroom mode, and performs other functions related to Classroom mode.