Component:ContactsDialog

This is a Userspace Only component — It cannot be attached anywhere but inside the userspace. Changing components in userspace is not recommended and may break functionality of your dashboard. Proceed with caution even if you know what you're doing.

Component image 

File:ContactsDialogComponent.png

Contacts Dialog component as seen in the Scene Inspector

The ContactsDialog component is used in the contacts screen of the Dash Menu to search, view, and talk to contacts.

Fields

Fields

Name	Type	Description
persistent	Bool	Determines whether or not this item will be saved to the server.
UpdateOrder	Int	Controls the order in which this component is updated.
Enabled	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
_searchBar	TextField	The search bar to search for users.
_listRoot	Slot	The list of contacts.
_sessionsRoot	Slot	The slot where the list of sessions from the selected user will be.
_messagesRoot	Slot	The slot where the list of messages from the selected user will be.
_status	Image	The image icon being used for the selected user's status.
_avatar	Image	The image icon being used for the selected user's avatar image.
_username	Text	The text for the selected user's username.
_userActionsRoot	Slot	The root slot to store buttons for performing actions on the selected user.
_sendMessageButton	Button	The button for sending the currently typed message to the selected user.
_sendVoiceMessageButton	Button	The button for sending a voice message to the currently selected user.
_sendMessageTextField	TextField	The text field to type messages to send to users.
_messagesScrollRect	ScrollRect	The scroll rectangle component for the scroll area for messages to and from the selected user.
_inviteButton	Button	Invite the selected user to the currently focused session if possible.
_requestInviteButton	Button	Ask for an invite from the selected user.
_banAllButton	Button	Ban the selected user from all sessions that the current local user will host.
_banSessionButton	Button	Ban the selected user from the current focused session.
_unblockedButton	Button	The button to unblock the currently selected user.
_avatarBlockButton	Button	The button to block the currently selected user's avatar.
_mutualBlockButton	Button	The button to do a mutual block with the currently selected user.

Sync Delegates

Triggers

Method Name	Method type and Arguments.	Is the method hidden?	Description
SearchTextChanged:Action`1<TextEditor>	Action`1<TextEditor>	✓	The action to run and pass a text editor as an argument when changing the search text.
OnRemoveContact:ButtonEventHandler	ButtonEventHandler	✓	The method to run when removing a contact.
OnAddContact:ButtonEventHandler	ButtonEventHandler	✓	The method to run when adding a contact.
OnBanFromAll:ButtonEventHandler	ButtonEventHandler	✓	The method to run when banning all on a contact.
OnUnblock:ButtonEventHandler	ButtonEventHandler	✓	The method to run when unblocking a contact.
OnAvatarBlock:ButtonEventHandler	ButtonEventHandler	✓	The method to run when blocking the avatar of a contact.
OnMutualBlock:ButtonEventHandler	ButtonEventHandler	✓	The method to run when mutual blocking a contact.
OnBanFromCurrent:ButtonEventHandler	ButtonEventHandler	✓	The method to run when banning a contact from the current session.
OnIgnoreRequest:ButtonEventHandler	ButtonEventHandler	✓	The method to run when ignoring a contact request.
OnInviteContact:ButtonEventHandler	ButtonEventHandler	✓	The method to run when inviting a contact.
OnRequestInvite:ButtonEventHandler	ButtonEventHandler	✓	The method to run when requesting a contact from a user.
OnSendMessage:ButtonEventHandler	ButtonEventHandler	✓	The method to run when sending a message to a user.
OnStartRecordingVoiceMessage:ButtonEventHandler	ButtonEventHandler	✓	The method to run when starting a voice message to send a message to a user.
OnStopRecordingVoiceMessage:ButtonEventHandler	ButtonEventHandler	✓	The method to run when sending a voice message to a user.
MessageSubmitPressed:Action`1<TextEditor>	Action`1<TextEditor>	✓	The method to run when submitting a message to a user.

Usage

Not used by the user. Exists as the dash's Contacts tab.

Examples

Contacts tab in the Dash Menu

See Also

• Dash Menu