C# Class ForumClientCore.ClientController

Show file Open project: sagioto/forum Class Usage Examples

Public Properties

Property	Type	Description
loggedIn	bool

Public Methods

Method	Description
Activate ( ) : bool
AddModerator ( string usernameToAdd, string subforum ) : System.Result
AddSubforum ( string subforumName ) : System.Result
ClientController ( ) : System
ClientController ( bool GetCallBack ) : System	Constructor
Deactivate ( string username, string password ) : bool
EditPost ( Postkey postToEdit, string title, string body ) : System.Result
GetNumOfLoggedInUsers ( ) : int
GetPost ( Postkey postkey ) : Post
GetReplies ( Postkey postkey ) : ForumShared.SharedDataTypes.Post[]
GetSubforum ( String subforumname ) : ForumShared.SharedDataTypes.Post[]
GetSubforumsList ( ) : String[]
ListenOnForum ( string username, string subForumName ) : bool
Login ( string userName, string password ) : bool
Logout ( ) : bool
Post ( string subForumName, string title, string body ) : System.Result
Register ( string userName, string password ) : System.Result
RemoveModerator ( string usernameToRemove, string subforum ) : System.Result
RemovePost ( Postkey postkey ) : System.Result
RemoveSubforum ( string subforumName ) : System.Result
ReplaceAdmin ( string newAdminUsername, string newAdminPassword ) : System.Result
ReplaceModerator ( string usernameToAdd, string usernameToRemove, string subforum ) : System.Result
Reply ( Postkey originalPost, string title, string body ) : System.Result
ReportSubForumTotalPosts ( string subforumName ) : int
ReportUserTotalPosts ( string username ) : int
Subscribe ( string username ) : Post
netAdaptor_OnUpdateFromServer ( Post message ) : void	This method is an example of using NetworkAdaptor When netAdaptor invoked an event OnUpdateFromController it gets to this method

Private Methods

Method	Description
Ban ( string usernameToBan ) : System.Result
Search ( string query ) : ForumShared.SharedDataTypes.Post[]

Method Details

Activate() public method

public Activate ( ) : bool
return	bool

AddModerator() public method

public AddModerator ( string usernameToAdd, string subforum ) : System.Result
usernameToAdd	string
subforum	string
return	System.Result

AddSubforum() public method

public AddSubforum ( string subforumName ) : System.Result
subforumName	string
return	System.Result

ClientController() public method

public ClientController ( ) : System
return	System

ClientController() public method

Constructor

public ClientController ( bool GetCallBack ) : System
GetCallBack	bool
return	System

Deactivate() public method

public Deactivate ( string username, string password ) : bool
username	string
password	string
return	bool

EditPost() public method

public EditPost ( Postkey postToEdit, string title, string body ) : System.Result
postToEdit	Postkey
title	string
body	string
return	System.Result

GetNumOfLoggedInUsers() public method

public GetNumOfLoggedInUsers ( ) : int
return	int

GetPost() public method

public GetPost ( Postkey postkey ) : Post
postkey	Postkey
return	ForumShared.SharedDataTypes.Post

GetReplies() public method

public GetReplies ( Postkey postkey ) : ForumShared.SharedDataTypes.Post[]
postkey	Postkey
return	ForumShared.SharedDataTypes.Post[]

GetSubforum() public method

public GetSubforum ( String subforumname ) : ForumShared.SharedDataTypes.Post[]
subforumname	String
return	ForumShared.SharedDataTypes.Post[]

GetSubforumsList() public method

public GetSubforumsList ( ) : String[]
return	String[]

ListenOnForum() public method

public ListenOnForum ( string username, string subForumName ) : bool
username	string
subForumName	string
return	bool

Login() public method

public Login ( string userName, string password ) : bool
userName	string
password	string
return	bool

Logout() public method

public Logout ( ) : bool
return	bool

Post() public method

public Post ( string subForumName, string title, string body ) : System.Result
subForumName	string
title	string
body	string
return	System.Result

Register() public method

public Register ( string userName, string password ) : System.Result
userName	string
password	string
return	System.Result

RemoveModerator() public method

public RemoveModerator ( string usernameToRemove, string subforum ) : System.Result
usernameToRemove	string
subforum	string
return	System.Result

RemovePost() public method

public RemovePost ( Postkey postkey ) : System.Result
postkey	Postkey
return	System.Result

RemoveSubforum() public method

public RemoveSubforum ( string subforumName ) : System.Result
subforumName	string
return	System.Result

ReplaceAdmin() public method

public ReplaceAdmin ( string newAdminUsername, string newAdminPassword ) : System.Result
newAdminUsername	string
newAdminPassword	string
return	System.Result

ReplaceModerator() public method

public ReplaceModerator ( string usernameToAdd, string usernameToRemove, string subforum ) : System.Result
usernameToAdd	string
usernameToRemove	string
subforum	string
return	System.Result

Reply() public method

public Reply ( Postkey originalPost, string title, string body ) : System.Result
originalPost	Postkey
title	string
body	string
return	System.Result

ReportSubForumTotalPosts() public method

public ReportSubForumTotalPosts ( string subforumName ) : int
subforumName	string
return	int

ReportUserTotalPosts() public method

public ReportUserTotalPosts ( string username ) : int
username	string
return	int

Subscribe() public method

public Subscribe ( string username ) : Post
username	string
return	ForumShared.SharedDataTypes.Post

netAdaptor_OnUpdateFromServer() public method

This method is an example of using NetworkAdaptor When netAdaptor invoked an event OnUpdateFromController it gets to this method

public netAdaptor_OnUpdateFromServer ( Post message ) : void
message	ForumShared.SharedDataTypes.Post
return	void

Property Details

loggedIn public property

public bool loggedIn
return	bool