Component:ContactsDialog: Difference between revisions

From Resonite Wiki
← Older edit
Visual
Automated: update Fields, SyncDelegates
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{UserspaceComponent}}
{{Infobox Component
{{Infobox Component
|Image=ContactsDialogComponent.png
|Image=ContactsDialogComponent.png
Line 20: Line 21:
|_messagesScrollRect|'''[[Component:ScrollRect|ScrollRect]]'''|TypeAdv11=true| The scroll rectangle component for the scroll area for messages to and from the selected user.
|_messagesScrollRect|'''[[Component:ScrollRect|ScrollRect]]'''|TypeAdv11=true| The scroll rectangle component for the scroll area for messages to and from the selected user.
|_inviteButton|'''[[Component:Button|Button]]'''|TypeAdv12=true| Invite the selected user to the currently focused session if possible.
|_inviteButton|'''[[Component:Button|Button]]'''|TypeAdv12=true| Invite the selected user to the currently focused session if possible.
|_requestInviteButton|'''[[Component:Button|Button]]'''|TypeAdv13=true|
|_requestInviteButton|'''[[Component:Button|Button]]'''|TypeAdv13=true| Ask for an invite from the selected user.
|_banAllButton|'''[[Component:Button|Button]]'''|TypeAdv14=true| Ban the selected user from all sessions that the current local user will host.
|_banAllButton|'''[[Component:Button|Button]]'''|TypeAdv14=true| Ban the selected user from all sessions that the current local user will host.
|_banSessionButton|'''[[Component:Button|Button]]'''|TypeAdv15=true| Ban the selected user from the current focused session.
|_banSessionButton|'''[[Component:Button|Button]]'''|TypeAdv15=true| Ban the selected user from the current focused session.
Line 30: Line 31:
== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|SearchTextChanged(TextEditor)|[[Type:Delegate|Delegate]]<[[Component:TextEditor|TextEditor]]: editor> -> [[Type:Void|Void]] : HIDDEN METHOD|
|SearchTextChanged:[[Type:Action`1|Action`1]]<[[Component:TextEditor|TextEditor]]>|[[Type:Action`1|Action`1]]<[[Component:TextEditor|TextEditor]]>|true| The action to run and pass a text editor as an argument when changing the search text.
|OnRemoveContact(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|OnRemoveContact:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| The method to run when removing a contact.
|OnAddContact(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|OnAddContact:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| The method to run when adding a contact.
|OnBanFromAll(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|OnBanFromAll:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| The method to run when banning all on a contact.
|OnUnblock(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|OnUnblock:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| The method to run when unblocking a contact.
|OnAvatarBlock(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|OnAvatarBlock:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| The method to run when blocking the avatar of a contact.
|OnMutualBlock(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|OnMutualBlock:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| The method to run when mutual blocking a contact.
|OnBanFromCurrent(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|OnBanFromCurrent:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| The method to run when banning a contact from the current session.
|OnIgnoreRequest(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|OnIgnoreRequest:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| The method to run when ignoring a contact request.
|OnInviteContact(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|OnInviteContact:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| The method to run when inviting a contact.
|OnRequestInvite(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|OnRequestInvite:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| The method to run when requesting a contact from a user.
|OnSendMessage(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|OnSendMessage:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| The method to run when sending a message to a user.
|OnStartRecordingVoiceMessage(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|OnStartRecordingVoiceMessage:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| The method to run when starting a voice message to send a message to a user.
|OnStopRecordingVoiceMessage(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|OnStopRecordingVoiceMessage:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| The method to run when sending a voice message to a user.
|MessageSubmitPressed(TextEditor)|[[Type:Delegate|Delegate]]<[[Component:TextEditor|TextEditor]]: editor> -> [[Type:Void|Void]] : HIDDEN METHOD|
|MessageSubmitPressed:[[Type:Action`1|Action`1]]<[[Component:TextEditor|TextEditor]]>|[[Type:Action`1|Action`1]]<[[Component:TextEditor|TextEditor]]>|true| The method to run when submitting a message to a user.
}}
}}


Latest revision as of 18:24, 3 April 2025

This is a userspace component — you cannot attach it anywhere but the userspace. Messing with the userspace can be fun, but it is not recommended as you risk messing your dash up if you don't 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

Retrieved from "https://wiki.resonite.com/index.php?title=Component:ContactsDialog&oldid=98812"