Show / Hide Table of Contents

Class Invitations

Inheritance
System.Object
Invitations
Implements
IHasClientControlledContainers
IController
IViewController
IHasUniversalID
Namespace: Eco.Gameplay.Utils
Assembly: Eco.Gameplay.dll
Syntax
public class Invitations : Object, IHasClientControlledContainers, IController, IViewController, IHasUniversalID

Constructors

Invitations()

Declaration
public Invitations()

Properties

ControllerID

Declaration
public ref int ControllerID { get; }
Property Value
Type Description
System.Int32

Description

Declaration
public LocString Description { get; }
Property Value
Type Description
LocString

InvitationList

Declaration
[ClientCanSelectAndAdd("Invite Citizens or Groups to Join", "Invite", "Invites", true)]
public ControllerAliasSet InvitationList { get; set; }
Property Value
Type Description
ControllerAliasSet

Methods

AcceptIfNotMember(User)

Accept incoming invitation and handle different states.

Declaration
public Task AcceptIfNotMember(User user)
Parameters
Type Name Description
User user
Returns
Type Description
System.Threading.Tasks.Task

Clear()

Declaration
public void Clear()

Destroy()

Declaration
public void Destroy()

Initialize(LocString, LocString, ILinkable, NotificationCategory, Func<User, Task<Boolean>>, Func<User, Boolean>, String)

Declaration
public void Initialize(LocString actionDesc, LocString membershipBenefit, ILinkable source, NotificationCategory tag, Func<User, Task<bool>> onAccept, Func<User, bool> isMember, string parentDeedLinkId)
Parameters
Type Name Description
LocString actionDesc
LocString membershipBenefit
ILinkable source
NotificationCategory tag
System.Func<User, System.Threading.Tasks.Task<System.Boolean>> onAccept
System.Func<User, System.Boolean> isMember
System.String parentDeedLinkId

IsInvited(IAlias)

Declaration
public bool IsInvited(IAlias alias)
Parameters
Type Name Description
IAlias alias
Returns
Type Description
System.Boolean

TryRemoveInvitation(INetObject, Object)

Remove invitation and delete mail in the process (if it's a demographics its not gonna be removed from the list so just remove the users mail).

Declaration
public void TryRemoveInvitation(INetObject caller, object obj)
Parameters
Type Name Description
INetObject caller
System.Object obj

Implements

IHasClientControlledContainers
IController
IViewController
IHasUniversalID

Extension Methods

TagUtils.TagNames(Object, Boolean)
TagUtils.TagDisplayNames(Object, Boolean)
ClientSetViewExtensions.SetClassOfProperty(Object, Player, String, String, Int32)
TypeTooltipExtensions.UILinkGeneric(Object)
☀
☾
In This Article
Back to top
Copyright (c) Strange Loop Games 2021
☀
☾