LanguageForgeAPI¶

User Functions¶

bool isUser(string userName)

UserDTO addUser(UserModel user)
- Always succeeds. Changes given UserName if required to succeed and returns actual UserName in returned UserDTO

UserListDTO searchUser(string pattern)
- Similar to lex api search return type

void addUserToProject(string projectId, string userName)

UserListDTO listUsersInProject(string projectId)

Project Functions¶

void addProject(ProjectModel project)
- Note can throw an exception. e.g. Project already exists.

ProjectListDTO listProjects(int from, int to)
- Return all projects starting from row 'from', ending at row 'to'.

ProjectListDTO searchProject(string pattern, int maxResultCount)
- Return all partial matches on ProjectName to pattern up to maxResultCount

Community Functions¶

void addCommunity(CommunityModel project)
- Note can throw an exception. e.g. Community already exists

CommunityDTO listCommunities(int from, int to)
- Return all communites starting from row 'from', ending at row 'to'.

CommunityDTO searchCommunity(string pattern, int maxResultCount)
- Return all partial matches on CommunityName to pattern up to maxResultCount

Model/DTO Classes¶

These classes are used as return types, or arguments to the api methods described above.

UserDTO:
- UserId
- UserName
- Name
- Email

UserListDTO:
- List<UserDTO>

UserModel
- UserName
- Name
- Email

ProjectDTO
- ProjectId
- ProjectName

ProjectListDTO
- List<ProjectDTO>

ProjectModel
- ProjectName
- VernacularWritingSystems<string> (an array of Writing System codes used in the project)
- AnalysisWritingSystems<string> (an array of Writing System codes used in the project)

CommunityDTO
- CommunityId
- CommunityName

CommunityModel
- CommunityName