Developer's Guide - EPiServer World

More documents

Recommendations

Info

46 | Developer’s Guide EPiServer Community 3.1 2.12 Club Clubs are mini-communities within a community. A club has a separate member list, club news, forums and image galleries etc. Clubs can be treated in different ways; they can be hidden, which means that only people who know about them can become members. It can have different security states: closed or open. Closed clubs require approval from its owner before allowing more members, while open clubs are free to join by anyone. Clubs can also be created and wait for subsequent approval from an administrator, or the community can allow for free creation of clubs. 2.12.1 Adding a Club Adding a club through the API is useful when users want to create their own clubs based on topics. Import Necessary Namespaces First import the necessary namespaces that will be used to add a club. The namespaces StarCommunity.Modules.Club, StarCommunity.Cre.Modules.Security and StarCommunity.Core are described by clicking on their respective names. Make sure you add the assemblies as references, as mentioned in section 1.1.1. using StarCommunity.Core; using StarCommunity.Core.Modules.Security; using StarCommunity.Modules.Club; Creating the Club In this example we start by getting the User object instances of the users we want as the creator and owner of the club. Secondly we have decided to set this club as approved, visible and with security status set to SecurityStatus.Closed. //Get the creator by id IUser creator = (IUser)StarCommunitySystem. CurrentContext.DefaultSecurity.GetUser(1234); //Get the owner by id IUser owner = (IUser)StarCommunitySystem. CurrentContext.DefaultSecurity.GetUser(12345); bool isApproved = false; bool isHidden = false; Club club = new Club("Club name", "Club description", isApproved, null, null, SecurityStatus.Closed, "Reason for creation", creator, owner, null, isHidden); club = ClubHandler.AddClub(club); Finally we add the club to database by calling the AddClub method. The new Club object instance with its ID property set is returned. © EPiServer AB
Tutorials | 47 2.12.2 Removing a Club Removing a club can be done either temporarily or permanently. As with users, a permanent removal means there is no way of undoing the action, while a temporary removal only results in the club not appearing in listings and search queries. Importing Necessary Namespaces First import the necessary namespaces that will be used to remove a club. The namespace StarCommunity.Modules.Club is described by clicking on its name. Make sure you add the assembly as a reference, mentioned in section 1.1.1. using StarCommunity.Modules.Club; Removing a Club To temporarily remove a club get the Club object instance id, and send it as a parameter to the RemoveClub method. If we would now try to get the Club object instance with the GetClub method, the club’s Removed property would be set to true. //Get the club by id Club club = ClubHandler.GetClub(1234); //Temporarily remove the club ClubHandler.RemoveClub(club); Permanently Removing a Club To permanently remove a club we start off in the same way as we did with temporary removal. The difference is when we call the RemoveClub method, since this time we pass the permanent parameter as true. If you try to retrieve the Club object instance now, using the GetClub method, it will return null since the club no longer exists in the database. //Get the club by id Club club = ClubHandler.GetClub(1234); //Permanently remove the club ClubHandler.RemoveClub(club, true); 2.12.3 Adding Club Members Becoming a member of a club is necessary if you want to share its information. A club owner does not have to go through the process of becoming a member after creating a club, since owners are automatically added to the member’s list. This article will show you, the developer, how to add a user as a member of a club and what the different results will be if the club is closed or open. © EPiServer AB
Page 1 and 2:
Release 3.1.0 Developer’s Guide
Page 3 and 4:
Table of Contents | 3 Table of Cont
Page 5 and 6:
Basic Understanding | 5 2.10.5 Addi
Page 7 and 8:
Basic Understanding | 7 1 Basic Und
Page 9 and 10:
Basic Understanding | 9 1.2.2 EPiSe
Page 11 and 12:
Basic Understanding | 11 StarCommun
Page 13 and 14: Basic Understanding | 13 1.2.4 EPiS
Page 15 and 16: Basic Understanding | 15 If MyClass
Page 17 and 18: Basic Understanding | 17 1.3.4 Star
Page 19 and 20: Basic Understanding | 19 1.3.18 Sta
Page 21 and 22: Table of Contents | 3 2 Tutorials 2
Page 23 and 24: Tutorials | 5 Note that when changi
Page 25 and 26: Tutorials | 7 IUser user = (IUser)S
Page 27 and 28: Tutorials | 9 user.BirthDate = new
Page 29 and 30: Tutorials | 11 Attaching the Group
Page 31 and 32: Tutorials | 13 The Tag object is de
Page 33 and 34: Tutorials | 15 2.3.4 Retrieving ent
Page 35 and 36: Tutorials | 17 //Get the category b
Page 37 and 38: Tutorials | 19 2.6 Queries The Quer
Page 39 and 40: Tutorials | 21 2.6.4 Remove Query R
Page 41 and 42: Tutorials | 23 // Create a blog ent
Page 43 and 44: Tutorials | 25 Below an example of
Page 45 and 46: Tutorials | 27 The logging frequenc
Page 47 and 48: Tutorials | 29 Committing the chang
Page 49 and 50: Tutorials | 31 Get All Blog Entries
Page 51 and 52: Tutorials | 33 2.10 Calendar Calend
Page 53 and 54: Tutorials | 35 Create a New Event C
Page 55 and 56: Tutorials | 37 Create Recurrent Eve
Page 57 and 58: Tutorials | 39 Import Necessary Nam
Page 59 and 60: Tutorials | 41 2.11 Chat The Chat M
Page 61 and 62: Tutorials | 43 2.11.2 Base The base
Page 63: Tutorials | 45 2.11.5 MessageBox Th
Page 67 and 68: Tutorials | 49 Adding an Ad with an
Page 69 and 70: Tutorials | 51 Import Necessary Nam
Page 71 and 72: Tutorials | 53 Get the contact rela
Page 73 and 74: Tutorials | 55 Then create a new Co
Page 75 and 76: Tutorials | 57 2.14.5 Configuration
Page 77 and 78: Tutorials | 59 Then we get the cont
Page 79 and 80: Tutorials | 61 To get a UserCollect
Page 81 and 82: Tutorials | 63 Now we are ready to
Page 83 and 84: Tutorials | 65 Folder inbox = dmc.G
Page 85 and 86: Tutorials | 67 Then we remove it: D
Page 87 and 88: Tutorials | 69 2.17.6 Configuration
Page 89 and 90: Tutorials | 71 2.18.2 Add a Member
Page 91 and 92: Tutorials | 73 Check if a User is a
Page 93 and 94: Tutorials | 75 Assign a Question To
Page 95 and 96: Tutorials | 77 Get Questions Assign
Page 97 and 98: Tutorials | 79 2.19 Forum Forums ar
Page 99 and 100: Tutorials | 81 Locking the Topic To
Page 101 and 102: Tutorials | 83 2.19.7 Removing a Re
Page 103 and 104: Tutorials | 85 First we need the Im
Page 105 and 106: Tutorials | 87 To begin with, we ne
Page 107 and 108: Tutorials | 89 2.21 Moblog The Mobl
Page 109 and 110: Tutorials | 91 2.22 MyPage The EPiS
Page 111 and 112: Tutorials | 93 Getting Blocked User
Page 113 and 114: Tutorials | 95 2.23 NML NML is a ma
Page 115 and 116:
Tutorials | 97 Limiting Maximum Wor
Page 117 and 118:
Tutorials | 99 Getting a User’s L
Page 119 and 120:
Tutorials | 101 Add a Poll In this
Page 121 and 122:
Tutorials | 103 Voting in a Poll To
Page 123 and 124:
Tutorials | 105 2.25.6 Add Choices
Page 125 and 126:
Tutorials | 107 Import Necessary Na
Page 127 and 128:
Tutorials | 109 2.27.2 Adding video
Page 129 and 130:
Tutorials | 111 Calling AddVideo pr
Page 131 and 132:
Tutorials | 113 2.27.6 Get preview
Page 133 and 134:
Tutorials | 115 2.28 Webmail Webmai
Page 135 and 136:
Tutorials | 117 Import Necessary Na
Page 137 and 138:
Tutorials | 119 Accessing a Mailbox
Page 139 and 140:
Tutorials | 121 Note that it is rec
Page 141 and 142:
Extending EPiServer Community | 123
Page 143 and 144:
Page 145 and 146:
Page 147 and 148:
Page 149 and 150:
show all

Developer's Guide - EPiServer World

Create successful ePaper yourself

Delete template?

Save as template?